SureTax DRC API
Get Form Instances
Overview
This API endpoint retrieves comprehensive details regarding a specific generated form instance. It provides clients with essential information such as form ID, name, format, size, availability of logs, visualization support, and current status.
OperationId: Get Form Instances
Authorization Method(s): OAuth
Verb: GET
End Point: /api/Forms/FormInstances
Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Id* | Id | string |
Overview
Represents the overall response object containing form instances data.
Example Response
The following is an example response you can expect for this operation
{
"data": {
"formInstances": [
{
"id": "string",
"name": "string",
"format": "string",
"size": "string",
"isLogAvailable": "string",
"isChangeLogAvailable": "string",
"visualization": "string",
"status": "string"
}
]
}
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | The API response contains a list of form instances with their details. Success Response - 200 OK. The API will respond with a list of form instances and their information. |
| 204 | 204 No Content If no records are found for the provided request, the API will respond with a No Content status. |
| 400 | Bad request. The API will respond with an error if there is an issue with the request parameters. |
| 401 | Unauthorized request. The API will respond with an error if the user is not authenticated. |
| 500 | Internal server error. The API will respond with an error if there is an unexpected server issue. |