SureTax DRC API
Get Form Instance URL
Overview
This API endpoint facilitates the retrieval of a URL that enables users to view or edit a specific form instance within the client UI. The URL generated by this endpoint grants direct access to the form instance, providing users with the ability to either view or modify its contents as needed. The URL includes authentication-related data required for secure access and has an expiration time to ensure security measures.
OperationId: Get Form Instance URL
Authorization Method(s): OAuth
Verb: GET
End Point: /api/Forms/FormInstanceURL
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 |
| Action* | Action | string |
Overview
Response object containing the URL for accessing or editing the form instance.
Example Response
The following is an example response you can expect for this operation
{
"data": {
"url": "https://zuse1-taa-aps-suretax-returns-formsetup--cert.azurewebsites.net?sessionId=1d829c7c-91cd-4ceb-af48-60818b41297b\u0026action=Edit"
}
}
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 URL for the specified form instance. Success Response - 200 OK. |
| 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. Invalid parameters or missing required information. |
| 401 | Unauthorized access. The request requires user authentication. |
| 500 | Internal server error. An error occurred while processing the request. |