Withdraw

This operation transfers the applicant's decision to withdraw the application to the relevant organisation's IT system.

path Parameters
CaseID
required
string

A fully qualified application number.

header Parameters
OrganisationID
required
string

Used by the API gateway to route the request to the relevant organisation.

IdempotencyId
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json

Information request object

caseStatus
required
string [ 1 .. 80 ] characters

This is to track the application status.

withdrawalDate
required
string <date> non-empty

This is to track the date on which the case is withdrawn.

withdrawalReason
string

This is to track the reason for which the case is withdrawn.

Array of objects (DownloadableDocument)

Applicable for state DA.

required
object (UpdatedBy)

Responses

Request samples

Content type
application/json
{
  • "caseStatus": "Submitted",
  • "withdrawalDate": "2019-08-24",
  • "withdrawalReason": "string",
  • "documents": [
    ],
  • "updatedBy": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": 404,
  • "message": "Internal Server error 19876",
  • "activityId": "00000011-0ab-xy00-0000-500000000000",
  • "errorCode": "DPE_TMS01",
  • "errorDetails": "Inner Exceptions, Stack Trace, etc"
}
Next to RequestAddInfo