Withdraw

This operation transfers the council's decision to withdraw the Digital Service from the council's IT system to the Online Digital Services.

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 request is originated from.

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
withdrawalDate
required
string <date>

Date on which case is withdrawn

withdrawalReason
string <= 512 characters

The reason as to why the case is withdrawn

Array of objects (DownloadableDocument)
updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal

Responses

Request samples

Content type
application/json
{
  • "withdrawalDate": "2019-08-24",
  • "withdrawalReason": "string",
  • "Documents": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}
Next to ReqAddInfo