UpdateAdditionalInfo

This operation transfers the additional information uploaded by the applicant from the Online Post-consent Certificate 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

The council LGA name or Private Certifier Organisation name to indicate where the response is routed to.

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 non-empty

Status of the request for additional information

childCaseID
string

An AI case id for RFI

responseDate
required
string <date> non-empty

Date and time of response

responseDetails
string

Additional information description provided by the applicant

Array of objects (DownloadableDocument)
object (updatedBy)

Responses

Request samples

Content type
application/json
{
  • "caseStatus": "Complete",
  • "childCaseID": "AI-XXXX",
  • "responseDate": "2019-08-24",
  • "responseDetails": "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"
}