AcceptReturn

This operation transfers the council's decision whether to accept or return the DA case from the council's IT system to the Online DA Service.

path Parameters
CaseID
required
string

A fully qualified Portal application number

header Parameters
OrganisationID
required
string

The council LGA name to indicate the request is originating from a specific council

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
lodgementOutcome
required
string
Enum: "Application was lodged" "Application was returned"

Result of council's lodgement process

isFeesPaid
boolean

Mandatory if DA has been accepted.

totalFeesPaid
number

Fees paid by the applicant. Required only if fees have been paid.

councilReferenceNumber
required
string <= 20 characters

The internal DA Id generated in the council system

acceptDate
string <date>

Date application was lodged in the council system. Mandatory if DA has been accepted.

returnDate
string <date>

Date application was returned to the applicant. Mandatory if DA has been returned.

returnReason
string

The reason council is returning the application. Mandatory if DA has been returned.

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

User must be registered in the planning portal

Responses

Request samples

Content type
application/json
{
  • "lodgementOutcome": "Application was lodged",
  • "isFeesPaid": true,
  • "totalFeesPaid": 1250.9,
  • "councilReferenceNumber": "DA201900049",
  • "acceptDate": "2019-08-24",
  • "returnDate": "2019-08-24",
  • "returnReason": "string",
  • "Documents": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}