Withdraw

This operation transfers the relevant organisation's decision to withdraw the application from their IT system to the ePlanning.

path Parameters
CaseID
required
string

A fully qualified application number

header Parameters
OrganisationID
required
string

The relevant 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>

This is to track the date on which the case is withdrawn

withdrawalReason
string <= 512 characters

This is to track the reason why the case is withdrawn.Please refer to the reference data API for the latest values. For Housing and Productivity contribution cases, one of the predefined reasons per below can be used while withdrawing the case. 1.Applicable contributions framework not available in the Portal 2.Contributions framework no longer applicable 3.Other

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"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "Case withdrawn",
  • "activityId": "string",
  • "Documents": [
    ]
}
Next to ReqAddInfo