SureTax Returns API

PATCH Form Instances

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint facilitates the updating of the status associated with a form instance. It allows clients to modify the status of a form instance based on their specific requirements or workflow processes.

OperationId: PATCH Form Instances

Authorization Method(s): OAuth

Verb: PATCH

End Point: /api/v1/Forms/FormInstances

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
Form Instance	formInstance	array[PatchFormInstanceRequestDetails]

PatchFormInstanceRequestDetails

Display Name	Field Name	Field Type
Id	id	string
Status	status	string

Example Request

The following is an json request for this operation.

{
  "formInstances": [
    {
      "id": "string",
      "status": "string"
    }
  ]
}

*Mandatory parameter

PatchFormInstancesResponse

OVERVIEWEXAMPLE

Overview

Response object for PATCH requests that update form instances, including error messages for any issues encountered during the update process.

PatchFormInstancesResponse

Display Name	Field Name	Field Type
Data	data	PatchFormInstancesData

PatchFormInstancesData

Display Name	Field Name	Field Type
Form Instances	formInstances	array[FormInstanceError]

FormInstanceError

Display Name	Field Name	Field Type
Id	id	string
Error Message	errorMessage	string

Example Response

The following is an example response you can expect for this operation

{
  "data": {
    "formInstances": [
      {
        "id": "FORM12345",
        "errorMessage": "No errors."
      },
      {
        "id": "FORM67890",
        "errorMessage": "Error while updating form instance."
      }
    ]
  }
}

Response Codes

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 the updated form instances along with any error messages.
400	Bad request. Invalid data provided.
401	Unauthorized access.
500	Internal server error.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/FormInstances

Add Request Headers:

{
  "formInstances": [
    {
      "id": "string",
      "status": "string"
    }
  ]
}