This operation transfers the council's/certifier's decision to return the Digital Service from the council's/Certifier's IT system to the Online Digital Service. This operation does not apply to Post consent certificates, Complying Development Certificate, Development Application and Certificate Registration. This is a functionality which supports upcoming releases for new Digital Services APIs.
| CaseID required | string A fully qualified application number or case id |
| 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" |
| returnDate required | string <date> Date of return |
| returnReasons required | Array of strings (returnReason) Items Enum: "Incomplete" "Poor Quality" "Payment Not Received" "Other" |
| returnReasonDescriptionForOther required | string <= 512 characters 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 |
{- "returnDate": "2019-08-24",
- "returnReasons": [
- "Incomplete"
], - "returnReasonDescriptionForOther": "string",
- "updatedByEmail": "john.smith@gmail.com"
}