ReqAddInfo

This operation transfers the council's request for the certifier to provide additional information from the Online Certificate Registration Service to the certifier's IT system.

path Parameters
CaseID
required
string

A fully qualified application number or case id

header Parameters
OrganisationID
required
string

Private Certifier organisation ID

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: */*

body

caseStatus
string <= 100 characters

Status of the request for additional information

childCaseID
string

An AI case id for RFI

requestDate
string <date>

Date and time of response

requestDetails
required
string [ 1 .. 512 ] characters

Short description of request

Array of objects (DownloadableDocument)

Responses

Request samples 

curl -i -X PUT \
  /ReqAddInfo/:CaseID \
  -H 'Content-Type: */*' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string'

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 Register