Skip to content

Section 68 - Council to ePlanning API (v1)

Authentication

Please use the subscription key provided by the Department to access the APIs.

Overview
Languages
Servers

https://api-uat.apps1.nsw.gov.au/planning/onlineS68/v1/

AcceptReturn

Request

This operation transfers the Council's decision to proceed or not proceed the section 68 Certificate case from Council's IT system to the Online Section 68 Service.

Path
CaseIDstringrequired

A fully qualified Section 68 of the Local Government Act case

Headers
OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

IdempotencyIDstringrequired

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"

Bodyapplication/jsonrequired

Information request object

outcomeOfReviewstring(ReviewOfOutcome)required

What is the outcome of your review, Accept application for assessment or Application returned. One of the below mentioned values must be selected for ReviewOfOutcome 1. Accept application for assessment 2. Application returned

Example: "Refer to description for values"
isFeePaidboolean

Applicant paid the relevant fees. Conditional Mandatory when What is the outcome of your review? equals to:"Accept application for assessment"

feeAmountnumber(decimal)

Total fee paid. Conditional Mandatory when Applicant paid the relevant fees? equals to:"Yes"

Example: 1250.9
councilUniqueIDNumbernumber<= 20 characters

Council unique identification number. Conditional Mandatory when daFeePaid equals to:"Yes/No"

applicationLodgedDatestring(date)

Enter the date the application was lodged into the Council system. Conditional Mandatory when Applicant paid the relevant fees equals to "Yes/No". Date of lodgement can not be a future date

Example: "2020-12-30"
rejectReasonstring<= 512 characters

Reason for return the applicaion by council. Conditional Mandatory when What is the outcome of your review? is equals to "Application returned"

rejectDatestring(date)

applcation rejected date by council. Conditional Mandatory when What is the outcome of your review? is equals to "Application returned". It can not be a future date.

Example: "2020-12-30"
isAgencyAssessmentReqboolean

Does the application require consultation? Mandatory when What is the outcome of your review? is "Accept application for assessment"

referralDetailsArray of objects(agencyToConsultWith)

Agencies to consult with. This is part of 'Section 68'. Applicable when- Does the application require consultation? is "Yes"

DocumentsArray of objects(DownloadableDocument)
updatedByEmailstring(UpdatedByEmail)required

user mail address who performing the action.

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineS68/v1/AcceptReturn/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "outcomeOfReview": "Refer to description for values",
    "isFeePaid": true,
    "feeAmount": 1250.9,
    "councilUniqueIDNumber": 0,
    "applicationLodgedDate": "2020-12-30",
    "rejectReason": "string",
    "rejectDate": "2020-12-30",
    "isAgencyAssessmentReq": true,
    "referralDetails": [
      {
        "agencyName": "Refer to description for values",
        "dueDate": "2020-12-30",
        "reasonForReferral": "string"
      }
    ],
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "https://api-tst.apps1.nsw.gov.au/planning/external/v1/Documents/Doc2"
      }
    ],
    "updatedByEmail": "string"
  }'

Responses

Case updated

Bodyapplication/json
statusCodeinteger
Example: 200
messagestring
activityIdstring
Referral CasesArray of objects(Referral Case Details)

Applicable when isAgencyAssessmentReq=="Yes"

DocumentsArray of objects(DocResponse)

Attached documents with eplanningDocIds.

Response
application/json
{ "statusCode": 200, "message": "string", "activityId": "string", "Referral Cases": [ {} ], "Documents": [ {} ] }

Determination

Request

This operation transfers the Council's determination decision to proceed or not proceed the Section 68 Certificate case from Council's IT system to the Online Section 68 Service.

Path
CaseIDstringrequired

A fully qualified Section 68 of the Local Government Act case

Headers
OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

Bodyapplication/json

Determination request object

determinationOutcomestring(This application has been assessed and has been)required

This application has been assessed and has been Approved or Refused or Deferred Commencement. One of the below mentioned values must be selected for DeterminationOutcome 1. Approved 2. Refused 3. Deferred Commencement

Example: "Refer to description for values"
determinationDatestring(date)

Certificate Determination Date .Conditional mandatory when "DeterminationOutcome" is "Approved" or "Deferred Commencement". It can not be a future date.

Example: "2020-09-10"
certificateRefusalReasonstring<= 512 characters

The reason council Refused the Certificate. Conditional mandatory when "DeterminationOutcome" is "Refused".

certificateRefusalDatestring(date)

Application refused date. Conditional mandatory when "DeterminationOutcome" is "Refused". It can not be a future date.

Example: "2020-01-04"
certificateDeferredReasonstring<= 512 characters

Deferred Commencement Details. Conditional Mandatory when "DeterminationOutcome" is "Deferred Commencement".

DocumentsArray of objects(DownloadableDocument)
updatedByEmailstring(UpdatedByEmail)required

user mail address who performing the action.

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineS68/v1/Determination/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "determinationOutcome": "Refer to description for values",
    "determinationDate": "2020-09-10",
    "certificateRefusalReason": "string",
    "certificateRefusalDate": "2020-01-04",
    "certificateDeferredReason": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "https://api-tst.apps1.nsw.gov.au/planning/external/v1/Documents/Doc2"
      }
    ],
    "updatedByEmail": "string"
  }'

Responses

Case updated

Bodyapplication/json
statusCodeinteger
Example: 200
messagestring
activityIdstring
DocumentsArray of objects(DocResponse)

Attached documents with eplanningDocIds.

Response
application/json
{ "statusCode": 200, "message": "string", "activityId": "string", "Documents": [ {} ] }