AcceptReturn

This operation transfers the Council decision to accept or return the Building information Certificate case from the Council IT system to the Online Building information Certificate Service.

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.

Request Body schema: application/json

Information request object

reviewOutcome
required
string

This is to track the outcome of council's update on completeness check, Accept application for assessment or return application. 1. Accept application for assessment 2. Return application

councilComments
string <= 100 characters

Comments for Building Information Certificate. Applicable when reviewOutcome is Accept application for assessment

councilUniqueIDNumber
string <= 128 characters

Required Council unique identification number. Applicable when reviewOutcome is Accept application for assessment

isFeePaid
boolean

Required Property captures if applicant had paid the fee or not. Applicable when reviewOutcome is Accept application for assessment

totalFeePaid
number <decimal>

Total fee paid by applicant. Applicable when reviewOutcome is Accept application for assessment

lodgementDate
string

Required to Enter the date the application was lodged into the council system. Applicable when reviewOutcome is Accept application for assessment. Future date is not allowed to be entered.

Array of objects (downloadableDocument)
returnReason
string <= 512 characters

Required to enter Reason for council to return the applicaion. Applicable when reviewOutcome is Return application

updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal

Responses

Request samples

Content type
application/json
{
  • "reviewOutcome": "Refer to description for values.",
  • "councilComments": "string",
  • "councilUniqueIDNumber": "string",
  • "isFeePaid": true,
  • "totalFeePaid": 1250.9,
  • "lodgementDate": "string",
  • "Documents": [
    ],
  • "returnReason": "string",
  • "updatedByEmail": "john.smith@gmail.com"
}

Response samples

Content type
application/json
{
  • "statusCode": 404,
  • "message": "Internal Server error 19876",
  • "activityId": "00000011-0ab-xy00-0000-500000000000",
  • "errorCode": "DPE_TMS01",
  • "errorDetails": "Inner Exceptions, Stack Trace, etc"
}