RequestAddInfo

This operation requests the relevant organisation to provide additional information.

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

childCaseID
string

This child case ID is to track the additional information request.

caseStatus
string

This field is to track the case status of the additional information request.

requestDate
string <date>

This is to track the date and time of the request

requestDetails
required
string non-empty

Short description of the request

Array of objects (DownloadableDocument)
required
object (UpdatedBy)

Responses

Request samples

Content type
application/json
{
  • "childCaseID": "AI-XXXX",
  • "caseStatus": "string",
  • "requestDate": "2019-08-24",
  • "requestDetails": "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 NotificationOfNODStatus