Return

This operation transfers the relevant organisation's decision to return 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
returnDate
required
string <date>

Date of return

returnReasons
required
Array of strings (returnReason)
returnReasonDescriptionForOther
required
string <= 512 characters

This is to track the detailed reason the council is returning the application, required only when return reason was selected as Other.

updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal

Responses

Request samples

Content type
application/json
{
  • "returnDate": "2019-08-24",
  • "returnReasons": [
    ],
  • "returnReasonDescriptionForOther": "string",
  • "updatedByEmail": "john.smith@gmail.com"
}
Next to Reassign