GET FormInstanceURL

Description

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.

ALT

Endpoint

• Endpoint: <environment base url>/v1.0/api/Forms/FormInstanceURL

• Method: GET

Request Parameters

Parameter Type Required Description
id String(max length 32) Yes Form instance id
action String Yes Action to perform (View/Edit)

Response Structure

{
  "data": {
    "url": "string"
  }
}

API Contract Permitted Values

action

Code Value
View Display only
Edit Edit

Constraints

  • When action equals View, the URL only allows viewing of the generated form.
  • When action equals Edit, the URL only allows editing of the generated form.
  • The URL contains an expiration time beyond which it is impossible to preview/edit the form.
  • The URL contains authentication-related tokens, so the client does not have reauthenticate to view/edit the generated form.

Sample Response

{
    "data": {
        "url": "https://zuse1-taa-aps-suretax-returns-formsetup--cert.azurewebsites.net?sessionId=1d829c7c-91cd-4ceb-af48-60818b41297b&action=Edit"
    }
}

Sample request [CURL]

curl --location 'https://testsuretaxapi.taxrating.net/v1.0/api/Forms/FormInstanceURL?Id=FB19EA86-9E12-4DB3-928E-00006A416099&Action=Edit' \
--header 'Authorization: Bearer <access_token_value>' \
--data ''