Withdraw

This operation transfers the applicant's decision to withdraw the CDC application from the Online CDC 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 [ 1 .. 80 ] characters

Status of the CDC case

withdrawalDate
string <date>

Date on which case is withdrawn

required
object (UpdatedBy)

Responses

Request samples

Content type
application/json
{
  • "caseStatus": "Submitted",
  • "withdrawalDate": "2019-08-24",
  • "updatedBy": {
    }
}

Response samples

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