Common - Inbound to ePlanning API
Common - Inbound to ePlanning API (v2)
Download OpenAPI description
Overview
Languages
Servers
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/
Bodyapplication/jsonrequired
This is to track the detailed reason the council is returning the application, required only when return reason was selected as Other.
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Return/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Return/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"returnDate": "2019-08-24",
"returnReasons": [
"Refer to description for values"
],
"returnReasonDescriptionForOther": "string",
"updatedByEmail": "john.smith@gmail.com"
}'Bodyapplication/jsonrequired
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Reassign/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Reassign/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"assignee": {
"person": {
"firstName": "John",
"otherName": "Darren",
"surname": "Smith",
"emailAddress": "john.smith@gmail.com",
"contactNumber": "string"
}
},
"updatedByEmail": "john.smith@gmail.com"
}'Bodyapplication/jsonrequired
body
This is to track the description of the response, required when certifier is providing additional information
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/ProvideAddInfo/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/ProvideAddInfo/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"provideDetails": "string",
"childCaseID": "string",
"Documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Additional Information Provided", "activityId": "string", "Documents": [ { … } ] }
Bodyapplication/jsonrequired
This is to track the reason why the case is withdrawn.Please refer to the reference data API for the latest values. For Housing and Productivity contribution cases, one of the predefined reasons per below can be used while withdrawing the case. 1.Applicable contributions framework not available in the Portal 2.Contributions framework no longer applicable 3.Other
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Withdraw/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Withdraw/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"withdrawalDate": "2019-08-24",
"withdrawalReason": "string",
"Documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Case withdrawn", "activityId": "string", "Documents": [ { … } ] }
Bodyapplication/jsonrequired
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/ReqAddInfo/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/ReqAddInfo/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"requestDetails": "string",
"Documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Request created", "caseID": "AI-XXXX", "activityId": "string", "Documents": [ { … } ] }
Bodyapplication/jsonrequired
Information request object
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CloseAICase/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CloseAICase/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"childCaseID": "AI-XXXX",
"updatedByEmail": "john.smith@gmail.com"
}'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Documents/{DocID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Documents/{DocID}' \
-H 'OrganisationID: string'Bodyapplication/jsonrequired
Information request object
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/UpdateMetadata/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/UpdateMetadata/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"Documents": [
{
"docID": "DATA-WORKATTACH-FILE PEC-DPE-EP-WORK CDC-7850!20201124T125127.562 GMT",
"isAssessmentDoc": true,
"isSensitiveDoc": true,
"isPublishDoc": true
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Bodyapplication/jsonrequired
body
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Payment/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Payment/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"updatedByEmail": "johnsmith@yopmail.com"
}'Response
application/json
{ "PaymentURL": "https://gpp-digital-ui-preprod.apps.pcf-ext.testservicensw.net?paymentReference= GPP-DIG-7LmKhNViSICwuH9GHdyoZg" }
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/GetCaseInfo/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/GetCaseInfo/{CaseID}' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/GetCaseInfoSync/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/GetCaseInfoSync/{CaseID}' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string'Response
No contenthttps://api-uat.apps1.nsw.gov.au/planning/Common/v2/GetRegisteredUsers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/GetRegisteredUsers \
-H 'organisationID: string'Response
application/json
{ "statusCode": 200, "message": "Operation successful, result attached", "registeredUsersList": [ { … } ] }
Bodyapplication/jsonrequired
Information request object
This is to track the reason(s) for adding new referral(s) and/or uploading documents.
Upload the documents if required as it is an optional field.
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateRef/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateRef/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"updateReason": "string",
"agencyList": [
{
"agencyName": "Refer to description for values",
"otherAgencyName": "string",
"agencyReferenceNumber": "string",
"reasonForReferral": "string",
"requiredDocumentType": [
"Refer to description for values"
]
}
],
"Documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Case Submitted by Applicant", "activityId": "string", "Documents": [ { … } ] }
Bodyapplication/jsonrequired
This is to track the title of the exhibition and this field is mandatory when the consent authority selects doesPublicExhibitionRequired is selected as true.
This is to track the start date of the exhibition and this field is mandatory when the applicant select doesPublicExhibitionRequired is selected as true.
This is to track the end date of the exhibition and this field is mandatory when the applicant select doesPublicExhibitionRequired is selected as true.
This is an optional field to provide comments in the exhibition details screen. This can be used during creation or updating the exhibition.
This field is applicable for State DA and Mandatory to provide detailed description in Exhibition details screen. This can be used during creation or updating the exhibition.
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateExhibition/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateExhibition/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"exhbitionTitle": "string",
"exhibitionStartDate": "2019-08-24",
"exhibitionEndDate": "2019-08-24",
"comments": "string",
"detailedDescription": "string",
"addNewsPaper": [
{
"nameOfNewsPaper": "string",
"hasSlotBooked": true,
"dateOfCirculation": "2019-08-24"
}
],
"Documents": [
{
"documentName": "test.docx",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com",
"isPublishDoc": true
}
],
"DocumentsToPublish": [
{
"docID": "DATA-WORKATTACH-FILE PEC-DPE-EP-WORK CDC-7850!20201124T125127.562 GMT.",
"isPublishDoc": true
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Exhibition case has been created successfully", "caseID": "EXH-1234", "Documents": [ { … } ] }
Bodyapplication/jsonrequired
This is to track the start date of the exhibition. This field is not applicable when the case status in 'On Exhibition' status.
This is to track the end date of the exhibition and this field is mandatory when the applicant select doesPublicExhibitionRequired is selected as true.
This is an optional field to provide comments in the exhibition details screen. This can be used during creation or updating the exhibition.
This field is applicable for State DA and Mandatory to provide detailed description in Exhibition details screen. This can be used during creation or updating the exhibition.
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/UpdateExhibition/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/UpdateExhibition/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"exhibitionStartDate": "2019-08-24",
"exhibitionEndDate": "2019-08-24",
"comments": "string",
"detailedDescription": "string",
"addNewsPaper": [
{
"nameOfNewsPaper": "string",
"hasSlotBooked": true,
"dateOfCirculation": "2019-08-24"
}
],
"Documents": [
{
"documentName": "test.docx",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com",
"isPublishDoc": true
}
],
"DocumentsToPublish": [
{
"docID": "DATA-WORKATTACH-FILE PEC-DPE-EP-WORK CDC-7850!20201124T125127.562 GMT.",
"isPublishDoc": true
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Case updated", "activityId": "string", "Documents": [ { … } ] }
Bodyapplication/jsonrequired
This is to track the application submission type. One of the below mentioned values must be selected for submission types. 1. I am making a personal submission 2. I am submitting on behalf of my organisation 3. I am submitting on behalf of a Government agency/authority
Example: "Refer to description for values"
A fully qualified exhibition case number which is associated with the relevant case ID provided in header.
Example: "EXH-XXXX"
This is to track the government agency/authority organisation name. Applicable when submissionType is 'I am submitting on behalf of a Government agency/authority'
This is to track the applicant's position in the organisation. Applicable when submissionType is 'I am submitting on behalf of a Government agency/authority'
Salutation of the user. One of the below mentioned values must be selected for salutaion of the user 1. Mr 2. Mrs 3. Ms 4. Miss
Example: "Refer to description for values"
This is to track if the person who submits does not want their name published. This is not applicable when submissionType is 'I am submitting on behalf of a Government agency/authority'
This is to track the State.One of the below mentioned values must be selected for state 1. Australian Capital Territory 2. New South Wales 3. Northern Territory 4. Queensland 5. South Australia 6. Tasmania 7. Victoria 8. Western Australia
Example: "Refer to description for values."
This is to track if the applicant has any political donations to report
This is to track the opinion of the applicant on the submission. One of the below mentioned values must be selected for submission content 1. I support it 2. I object to it 3. I am just providing comments
Example: "Refer to description for values"
Required applicant declaration for create submission.
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateSubmission/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateSubmission/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"submissionType": "Refer to description for values",
"exhibitionCaseID": "EXH-XXXX",
"organisationName": "string",
"positionInOrganisation": "string",
"title": "Refer to description for values",
"firstName": "string",
"familyName": "string",
"nameWithheld": true,
"email": "string",
"address1": "string",
"address2": "string",
"suburbTownPostcode": "string",
"postCode": 0,
"state": "Refer to description for values.",
"reportablePoliticalDonation": true,
"submissionConsent": "Refer to description for values",
"submission": "string",
"declarations": [
{
"declaration": "Refer to description for values"
}
],
"Documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Case updated", "activityId": "string", "Documents": [ { … } ] }
Bodyapplication/jsonrequired
This is to track the different reasons for rejecting. One of the below mentioned values must be selected for reject reasons 1. The application is illegible or unclear as to the development consent sought 2. The application does not contain the information specified in Part 1 of Schedule 1 of the EP&A Regulation 3. The application is for State significant development or designated development and is not accompanied by an environmental impact statement
Example: "Refer to description for values"
This is to track the detailed reason the council is rejecting the application
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Reject/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/Reject/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"rejectDate": "2019-08-24",
"rejectReason": "Refer to description for values",
"rejectReasonDescription": "string",
"updatedByEmail": "john.smith@gmail.com"
}'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/AllConsentConditions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/AllConsentConditions \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string'Conditions retrieved successfully.
This indicates the Condition ID generated by DPE.
Example: "COND-123"
This indicates the type of Conditions in library. conditionType can have following values. 1.Bespoke:indicates conditions in Council library at DPE 2.Model:indicates model conditions in DPE library 3.Prescribed:indicates prescribed conditions in DPE library (* Values are case sensitive)
Example: "Bespoke"
This indicates the title of Condition.
Example: "Approved Plans"
This indicates the condition text in HTML format. Council can receive images in condition text in the img tag. img tag contains the documentID of the image file. Council can use GetDocument API for retrieving imag e document by passing base64 encoded document key.
Example: "<p>Sample text <img height=\"255\" src=\"https%3A%2F%2Fapi-tst.apps1.nsw.gov.au%2Fplanning%2FDocMgmt%2Fv1%2FDocuments%2FDATA-CONTENT-IMAGE CONIMG21686646077367!PNG!/RTEIMAGES/\" width=\"500\"></p>"
This indicates the reason why a Condition is being added in Council library.
Example: "Plans condition"
This indicates the date from when condition will be effective in the ePlanning & Council system.
Example: "2022-03-16"
This indicates the expiration date of the condition.
Example: "2023-03-16"
This indicates the type of work mentioned in the condition. This field has following options - 1.Building Work, 2.Demolition Work, 3.Subdivision Work,4.Remediation Work, 5.Strata Subdivision, 6.Change of use, 7.Land Subdivision, 8.Other
Example: "Demolition Work"
This indicates the stage of development that are relevant to the condition. This field has following options - 1. During building work, 2. During demolition work, 3. During subdivision work, 4. Before building work commences, 5. Before remediation work commences, 6. Before subdivision work commences, 7. Before issue of an occupation certificate, 8. Ongoing use for subdivision work, 9. Occupation and ongoing use, 10. Before issue of a construction certificate, 11. Before issue of a subdivision certificate, 12. Before issue of a strata certificate, 13. Before issue of a subdivision works certificate, 14. On completion of demolition work, 15.On completion of remediation work, 16. Ongoing use for change of use, 17. Before demolition work commences, 18. During remediation work, 19. General condition
Example: "General condition"
This indicates the reason for adding this condition.
Example: "This is for reporting purpose"
This indicates the Council reference ID that's assigned by the Council for a specific Condition ID.
Example: "SAMPLE-123"
This indicates the time stamp when conditon gets updated.
Response
application/json
{ "conditions": [ { … } ] }
Bodyapplication/jsonrequired
CreateCondition request object
This indicates the title of Condition.
Example: "Approved Plans"
This indicates the condition text in HTML format. Council should send image document with png, jpg, jpeg extension(s) only in the img tag in Condition text. Image size can be maximum 600px in width and 252 px in height.
Example: "<p><img src ='http://councilbaseurl/Documents/ConImg2.png' width='300' height='150'></p>"
This indicates the reason for creating a condition.
Example: "Plans condition"
This indicates the date from when condition will be effective in the ePlanning & Council system.
Example: "2022-03-16"
This indicates the type of work mentioned in the condition. This field has following options - 1.Building Work, 2.Demolition Work, 3.Subdivision Work,4.Remediation Work, 5.Strata Subdivision, 6.Change of use, 7.Land Subdivision, 8.Other
Example: "Demolition Work"
This indicates the reason for adding this condition.
Example: "This is for reporting purpose"
This indicates the stage of development that are relevant to the condition. This field has following options - 1. During building work, 2. During demolition work, 3. During subdivision work, 4. Before building work commences, 5. Before remediation work commences, 6. Before subdivision work commences, 7. Before issue of an occupation certificate, 8. Ongoing use for subdivision work, 9. Occupation and ongoing use, 10. Before issue of a construction certificate, 11. Before issue of a subdivision certificate, 12. Before issue of a strata certificate, 13. Before issue of a subdivision works certificate, 14. On completion of demolition work, 15.On completion of remediation work, 16. Ongoing use for change of use, 17. Before demolition work commences, 18. During remediation work, 19. General condition
Example: "General condition"
This indicates the Council reference ID that's assigned by the Council for a specific Condition ID.
Example: "SAMPLE-123"
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CouncilLibrary
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CouncilLibrary \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"conditions": [
{
"conditionTitle": "Approved Plans",
"conditionText": "<p><img src ='\''http://councilbaseurl/Documents/ConImg2.png'\'' width='\''300'\'' height='\''150'\''></p>",
"conditionReason": "Plans condition",
"effectiveDate": "2022-03-16",
"typeOfWork": "Demolition Work",
"reasonForReporting": "This is for reporting purpose",
"developmentStage": "General condition",
"councilConditionID": "SAMPLE-123",
"updatedByEmail": "abc@gmail.com"
}
]
}'Condition(s) created sucessfully
These detils gets populated only in case of success where all the conditions gets successfully added in Eplanning
This indicates the Condition ID generated by DPE.
Example: "COND-123"
This indicates the Council reference ID that's assigned by the Council for a specific Condition ID.
Example: "SAMPLE-123"
Response
application/json
{ "statusCode": 200, "message": "Request is successfully executed", "conditionDetails": [ { … } ] }
Bodyapplication/jsonrequired
UpdateCondition request object
This indicates the title of the Condition.
Example: "Approved Plans"
This indicates the condition text in HTML format. Council should send image document with png, jpg, jpeg extension(s) only in the img tag in Condition text. Image size can be maximum 600px in width and 252 px in height.
Example: "<p><img src ='http://councilbaseurl/Documents/ConImg2.png' width='300' height='150'></p>"
This indicates the reason why a Condition is being added in Council library.
Example: "Plans condition"
This indicates the date from when the updated Condition will be effective in the ePlanning & Council system.
Example: "2022-03-16"
This indicates the expiration date of the updated condition.
Example: "2023-03-16"
This indicates the type of work mentioned in the condition. This field has following options - 1.Building Work, 2.Demolition Work, 3.Subdivision Work,4.Remediation Work, 5.Strata Subdivision, 6.Change of use, 7.Land Subdivision, 8.Other
Example: "Demolition Work"
This indicates the reason for adding this condition.
Example: "This is for reporting purpose"
This indicates the stage of development that are relevant to the condition. This field has following options - 1. During building work, 2. During demolition work, 3. During subdivision work, 4. Before building work commences, 5. Before remediation work commences, 6. Before subdivision work commences, 7. Before issue of an occupation certificate, 8. Ongoing use for subdivision work, 9. Occupation and ongoing use, 10. Before issue of a construction certificate, 11. Before issue of a subdivision certificate, 12. Before issue of a strata certificate, 13. Before issue of a subdivision works certificate, 14. On completion of demolition work, 15.On completion of remediation work, 16. Ongoing use for change of use, 17. Before demolition work commences, 18. During remediation work, 19. General condition
Example: "General condition"
This indicates the Council reference ID that's assigned by the Council for a specific Condition ID.
Example: "SAMPLE-123"
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CouncilLibrary/{ConditionID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CouncilLibrary/{ConditionID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"conditionTitle": "Approved Plans",
"conditionText": "<p><img src ='\''http://councilbaseurl/Documents/ConImg2.png'\'' width='\''300'\'' height='\''150'\''></p>",
"conditionReason": "Plans condition",
"newEffectiveDate": "2022-03-16",
"newExpiryDate": "2023-03-16",
"typeOfWork": "Demolition Work",
"reasonForReporting": "This is for reporting purpose",
"developmentStage": "General condition",
"councilConditionID": "SAMPLE-123",
"updatedByEmail": "abc@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Request is successfully executed" }
Headers
The relevant organisation name to indicate where the request is originated from.
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"
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CouncilLibrary/{ConditionID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CouncilLibrary/{ConditionID}' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-H 'ReasonForDeletion: string'Response
application/json
{ "statusCode": 200, "message": "Request is successfully executed" }
Request
This operation overwrites all the conditions specific to a development application. It is required to have atleast one general condition in the API request. During Mod and Review of a DA, if any condition needs to be retained from the previous determination then the Condition ID should be passed as stored in the previous case.
ConsentConditions request object
This indicates the Condition ID generated by DPE. This field should be empty if Conditon is applied only for a specific application and Condition is not available in Council library in DPE. This field is mandatory when the Condition type is selected as Prescribed or Model
Example: "COND-123"
This indicates the type of Conditions in library. If the condition type is sent as blank it will be treated as Bespoke condition if that condition ID is not available in the library. conditionType can have following values. 1.Bespoke:indicates conditions in Council library at DPE 2.Model:indicates model conditions in DPE library 3. Prescribed:indicates prescribed conditions in DPE library (* Values are case sensitive)
Example: "Bespoke"
This indicates the title of the Condition.
Example: "Approved Plans"
This indicates the condition text in HTML format. Council should send image document with png, jpg, jpeg extension(s) only in the img tag in Condition text. Image size can be maximum 600px in width and 252 px in height.
Example: "<p><img src ='http://councilbaseurl/Documents/ConImg2.png' width='300' height='150'></p>"
This indicates the reason why a Condition is being added in Council library.
Example: "Plans condition."
This indicates the reason for adding, modifying or deleting condition(s) during a MOD DA or Review of determination application. This is mandatory when any condition(s) in previously approved DA is altered.
Example: "Condition modified to change the hours of operation"
This indicates the type of work mentioned in the condition. This field is mandatory when the value for conditionID is empty. This field has following options - 1.Building Work, 2.Demolition Work, 3.Subdivision Work,4.Remediation Work, 5.Strata Subdivision, 6.Change of use, 7.Land Subdivision, 8.Other
Example: "Demolition work"
This indicates the stage of development that are relevant to the condition. This field has following options - 1. During building work, 2. During demolition work, 3. During subdivision work, 4. Before building work commences, 5. Before remediation work commences, 6. Before subdivision work commences, 7. Before issue of an occupation certificate, 8. Ongoing use for subdivision work, 9. Occupation and ongoing use, 10. Before issue of a construction certificate, 11. Before issue of a subdivision certificate, 12. Before issue of a strata certificate, 13. Before issue of a subdivision works certificate, 14. On completion of demolition work, 15.On completion of remediation work, 16. Ongoing use for change of use, 17. Before demolition work commences, 18. During remediation work, 19. General condition
Example: "General condition."
This indicates the Council reference ID that's assigned by the Council for a specific Condition ID.
Example: "SAMPLE-123"
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/ConsentConditions/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/ConsentConditions/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"conditions": [
{
"conditionID": "COND-123",
"conditionType": "Bespoke",
"conditionTitle": "Approved Plans",
"conditionText": "<p><img src ='\''http://councilbaseurl/Documents/ConImg2.png'\'' width='\''300'\'' height='\''150'\''></p>",
"conditionReason": "Plans condition.",
"modificationReason": "Condition modified to change the hours of operation",
"typeOfWork": "Demolition work",
"developmentStage": "General condition.",
"councilConditionID": "SAMPLE-123",
"updatedByEmail": "abc@gmail.com"
}
]
}'Response
application/json
{ "statusCode": 200, "message": "Request is successfully executed" }
Request
This operation allows the consent authority to validate and save the fields required for generating Notice of determination for a specific case (either draft version or final version) or validate and save the fields required for generating review letter if it is a review of a DA. The generation of NOD will happen offline and once the NOD is generated, ePlanning system will notify using the NotificationOfNODStatus API
GenerateNOD request object
This enables the consent authority to determine if a draft version (word document) or a final version (pdf document) of the NOD needs to be created. To generate a Final NOD, value 'true' to be supplied. For the draft NOD, 'false' value is required to be supplied.
This indicates the date from which consent starts to operate. This field is mandatory if it is a review of a DA and the previous determination outcome was refused and present determination outcome is approved. And this field is also mandatory if determination outcome is approved for new DAs.
Example: "2023-03-16"
This indicates the date from which consent lapses. This field is mandatory if it is a review of a DA and the previous determination outcome was refused and present determination outcome is approved. And this field is also mandatory if determination outcome is approved for new DAs.
Example: "2023-03-16"
This refers to the approval body that have given general terms of approval. This field is mandatory if it is an integrated development. For e.g, Mining Act 1992, Heritage Act 1977 etc.
Example: "Mining Act 1992"
This holds the details of the deferred matters. This field is mandatory if determination outcome is deferred commencement. This String can contain HTML data. The length of string should be kept <=50,000 to avoid data truncation/data loss. Only HTML tags supported are "paragraph", "numbered-list", and "non-numbered list". Please do not pass any other HTML tags in this field. Otherwise the display of data in NOD may not have the right formatting.
This indicates the name of the court case. This field is mandatory only when the determining authority is Land and Environment court.
This indicates associated LEC court case number. This field is mandatory only when the determining authority is Land and Environment court.
This indicates if the development is a concept development. Value 'true' indicates that it's a concept development and 'false' indicates that it's not a concept development. This field is mandatory if determination outcome is approved or deferred commencement.
This indicates the type of development for Concept development. This field have following options - 1.Concept development application with no development, 2.Concept development application and the first stage of development and 3.Concept development application and the final stage of development. This field is mandatory if isConceptDevelopment is true.
Example: "Concept development application with no development"
This indicates the list of stages of development that apply to this application. This field is mandatory if conceptDevelopmentType is "Concept development application and the first stage of development" or "Concept development application and the final stage of development"
Example: "Stage 1"
This indicates the classification code of the building. This field is mandatory for a new DA or a review of a DA if the typeOfWork is "Buildingwork" and developmentStage is anything but "Before issue of a Construction Certificate"
Example: "BCA 1234"
This indicates the IPC Hearing Date. This is mandatory If isIPCPublicHearing is true
Example: "2023-03-16"
This indicates the name of the person issuing determination.
Example: "John"
This indicates the title of the person that has delegated authority to determine the application
Example: "Council Officer"
This is to determine if contact person for enquiries different to the person issuing this determination.
This indicates the name of the person for enquiry mandatory when isContactPersonDifferentToPersonDetermining is true or if it is a review of a DA
Example: "Pattrick"
This indicates the title of the person for enquiry mandatory when isContactPersonDifferentToPersonDetermining is true or if it is a review of a DA
Example: "Assessment Officer"
This indicates the reason for approval or rejection. This String can contain HTML data. The length of string should be kept <=50,000 to avoid data truncation/data loss. Only HTML tags supported are "paragraph", "numbered-list", and "non-numbered list". Please do not pass any other HTML tags in this field. Otherwise the display of data in NOD may not have the right formatting.
Example: "Case is pending with LEC."
This indicates the determination outcome of the application.This field have following options 1.Approved, 2.Refused, 3.Deferred commencement consent
Example: "Approved"
This indicates the authorized determining authority. This field have following options 1.Central Sydney Planning Committee, 2.Sydney / Regional Planning Panel, 3.Local Planning Panel, 4.Council, 5.Minister for Planning, 6.Independent Planning Commission, 7.Land and Environment Court
Example: "Land and Environment Court"
This indicates the determination date of the application.
Example: "2023-03-16"
This indicates the application number of the modified DA. This field is mandatory if it is a review of a modified DA or it is a modification of a DA
Example: "PAN-1234"
This indicates the type of modification on the application. This field have following options - 1.Section 4.55 (1) of the Environmental Planning and Assessment Act 1979, 2.Section 4.55 (1A) of the Environmental Planning and Assessment Act 1979, 3.Section 4.55 (2) of the Environmental Planning and Assessment Act 1979 4.Section 4.56 of the Environmental Planning and Assessment Act 1979. This field is mandatory if it is a review of a modified DA or it is a modification of a DA
Example: "Section 4.55 (1) of the Environmental Planning and Assessment Act 1979"
URL of the image to be downloaded. This URL should be similar to documents. This refers to the name of the signature document needed as a part of NOD generation. This supports png, jpg, jpeg formats only in the document.
Example: "http://sampleURL.com/api/Documents/signature_PANID.jpg"
This field captures the review body making the determination. This field is mandatory only if it is a review of a DA. e.g. Council
Example: "Council"
This field captures the aspects of an application under review. This field is mandatory only if it is a review of a DA. The review considered the following aspects of the development application. e.g.- Determination or Conditions. This String can contain HTML data. The length of string should be kept <=50,000 to avoid data truncation/data loss. Only HTML tags supported are "paragraph", "numbered-list", and "non-numbered list". Please do not pass any other HTML tags in this field. Otherwise the display of data in NOD may not have the right formatting.
Example: "Determination"
This is to track the development description and is enabled for the consent authority to override the description entered by the applicant. This appears in the Notice of Determination document. This attribute is under development and will be enabled in the future release.
Example: "Alterations and additions to dwelling house including extension to first floor and reconfiguration of first floor rooftop terrace."
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/GenerateNOD/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/GenerateNOD/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"isFinalNOD": true,
"consentStartDate": "2023-03-16",
"consentLapseDate": "2023-03-16",
"approvalBody": "Mining Act 1992",
"deferredMattersDetails": "string",
"courtCaseName": "string",
"courtCaseNumber": "string",
"isConceptDevelopment": true,
"conceptDevelopmentType": "Concept development application with no development",
"conceptDevelopmentStages": "Stage 1",
"BCA": "BCA 1234",
"isIPCPublicHearing": true,
"IPCHearingDate": "2023-03-16",
"personIssuingDetermination": "John",
"titleOfPersonIssuingDetermination": "Council Officer",
"isContactPersonDifferentToPersonDetermining": true,
"contactPersonForEnquiry": "Pattrick",
"titleOfPersonForEnquiry": "Assessment Officer",
"reasonForApprovalOrRejection": "Case is pending with LEC.",
"determinationOutcome": "Approved",
"determiningAuthority": "Land and Environment Court",
"determinationDate": "2023-03-16",
"modifiedApplicationNumber": "PAN-1234",
"typeOfModification": "Section 4.55 (1) of the Environmental Planning and Assessment Act 1979",
"signatureName": "http://sampleURL.com/api/Documents/signature_PANID.jpg",
"reviewBody": "Council",
"aspectsUnderReview": "Determination",
"developmentDescription": "Alterations and additions to dwelling house including extension to first floor and reconfiguration of first floor rooftop terrace.",
"updatedByEmail": "abc@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "The generation of NOD will happen offline and once the NOD is generated, ePlanning system will notify using the NotificationOfNODStatus API" }
Bodyapplication/jsonrequired
SanitizeData request object
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/SanitizeData
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/SanitizeData \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"conditions": [
{
"conditionText": "<p>This a sample HTML condition text</p>"
}
]
}'Response
application/json
{ "conditions": [ { … } ] }
Request
This operation transfers the certifier's critical stage inspection (CSI) information from the certifier's IT system to the ePlanning portal after the inspection has been performed. This operation is applicable for Complying Development Certificate (CDC) and Construction Certificate (CC) applications and it is available only after the determination stage. Reference data values can be obtained from the reference data API using the PCC or CDC digital service along with the corresponding operation.
Headers
Bodyapplication/jsonrequiredThe council LGA name or Private Certifier Organisation name to indicate where the request is originated from.
body
This is to track the address. Either gurasID or the fullAddress is required to be supplied. If gurasID is not supplied, then fullAddress will be considered for update. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
This is to track the gurasID which helps to fetch the address from NSW address database (GURAS).
Example: 2636480
This is to track the date on which the inspection was completed. This should be after the the determination of the parent case.
Example: "2024-02-21"
This is to track the type of inspection. This is required for all types of inspection records. Please refer to the reference data API for the latest values. Following are the example values. 1.Footings 2.Slab reinforcement 3.Framework (prior to fixing floor, wall and ceiling linings) 4.Waterproofing 5. Stormwater drainage (prior to covering) 6.Service Penetrations 7.Bounding Wall Construction 8.Fire Resistance Level Wall 9.Swimming Pool Barrier 10.Final inspection 11. Other inspection
Example: "Footings"
This is to track the details of other inspection and is only applicable and required when the inspection type is 'Other inspection'.
Example: "other inspection details"
This is to track the optional notes from inspection.
This is to track the result of the inspection. Please refer to the reference data API for the latest values. Following are the example values. 1.Building works are satisfactory 2. Satisfactory - subject to additional requirements 3. Unsatisfactory - reinspection required
Example: "Building works are satisfactory"
This is to track the certifier details. Please note, when the inspection type is final inspection, then only Principal certifier details are mandatory and required. Otherwise, either Principal certifier details OR the Assigned Individual Certifier details must be provided.
This is to track the details of the principal certifier and their individual registration details.
This is to track the registration details of the individual certifier if the inspection was carried out by another certifier ( as agreed with the principal certifier). Either the principal certifier or the assigned individual certifier is expected to conduct the inspection and the values to be supplied accordingly.
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CSIPerformed/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CSIPerformed/CDC-1234 OR CFT-1234' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"propertyAndContactInformation": {
"applicantDetails": {
"fullName": "John Carter",
"email": "testapplicant@yopmail.com"
},
"ownerDetails": {
"fullName": "John Carter",
"email": "testapplicant@yopmail.com"
},
"siteAddress": {
"gurasID": 2636480,
"fullAddress": "68 CROWN STREET RIVERSTONE 2765"
},
"inspectionLocation": "9 AlEXANDER CRESCENT RIVERSTONE 2765"
},
"inspectionDetails": {
"dateOfInspection": "2024-02-21",
"inspectionType": "Footings",
"otherInspectionTypeDetails": "other inspection details",
"BASIXCertificateDetails": [
{
"BASIXCertificateNumber": "1370434S",
"issuanceDate": "2023-06-17",
"isSelected": true
}
],
"notesFromInspection": "string",
"resultOfInspection": "Building works are satisfactory"
},
"certifierDetails": {
"principalCertifierDetails": {
"accreditationNo": "BDC1234 OR AMR-123456",
"fullName": "John Smith"
},
"assignedIndividualCertifierDetails": {
"accreditationNo": "BDC1234 OR AMR-123456",
"fullName": "John Smith",
"email": "pc@dpie.com",
"mobileNumber": 434340789,
"organisationName": "John Smith",
"organisationAddress": "John Smith",
"ABN": "12 345 678 900",
"ACN": "123 456 789"
}
},
"documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Case has been created successfully.", "caseID": "INSP-2788 or WDN-2345", "activityId": "string", "Documents": [ { … } ] }
Request
This operation transfers the certifier's critical stage inspection (CSI) missed information from the certifier's IT system to the ePlanning portal. This operation is applicable for Complying Development Certificate (CDC) and Construction Certificate (CC) applications and it is available only after the determination stage. By performing this operation, the certifier declares that the work that would have been the subject of the missed inspection, is deemed satisfactory. Reference data values can be obtained from the reference data API using the PCC or CDC digital service along with the corresponding operation.
Headers
Bodyapplication/jsonrequiredThe council LGA name or Private Certifier Organisation name to indicate where the request is originated from..
body
This is to track the name of the applicant responsible for the aspect of development. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
Example: "John Carter"
This is to track the email address of the applicant responsible for the aspect of development. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
Example: "testapplicant@yopmail.com"
This is to track the name of the owner responsible for the aspect of development. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
Example: "John Carter"
This is to track the email ID of the owner responsible for the aspect of development. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
Example: "testapplicant@yopmail.com"
This is to track the address. Either gurasID or the fullAddress is required to be supplied. If gurasID is not supplied, then fullAddress will be considered for update. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
This is to track the gurasID which helps to fetch the address from NSW address database (GURAS).
Example: 2636480
This is to track the contact number of the owner responsible for the aspect of development.
Example: 434340748
This is to track the address. Either gurasID or the fullAddress is required to be supplied. If gurasID is not supplied, then fullAddress will be considered for update. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
This is to track the gurasID which helps to fetch the address from NSW address database (GURAS).
Example: 2636480
This is to track the date on which the inspection was scheduled.
Example: "2024-02-21"
This is to track the comments of the inspection that was missed. A high-level summary provided by the certifier with details of the missed inspection.
Example: "string"
This is to track the type of inspection. Required for all types of inspection records. Please refer to the reference data API for the latest values. Following are the example values. 1.Footings 2.Slab reinforcement 3.Framework (prior to fixing floor, wall and ceiling linings) 4.Waterproofing 5.Stormwater drainage (prior to covering) 6.Service Penetrations 7.Bounding Wall Construction 8.Fire Resistance Level Wall 9.Swimming Pool Barrier 10.Final inspection 11.Other inspection
Example: "Footings"
This is to track the details of other inspection and is only applicable and required when the inspection type is 'Other inspection'.
Example: "Provides the details when the inspectiontype is otherinspection"
This is to track to the optional notes from inspection.
Example: "A high-level notes provided by the certifier with details of the missed inspection. Details to include the circumstances that the principal certifier considers were unavoidable and caused it to be missed and that the work that would have been the subject of the missed inspection is satisfactory."
This is to track the list of documentary evidence relied on to satisfy the principal certifier that the work that would have been the subject of the missed inspection is satisfactory, including evidence of a kind referred to in the Building Code of Australia, A5G3.
Example: "These are the list of supporting documents, and here is a description of the documents, also these are he necessary comments on the evidence."
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CSIMissed/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CSIMissed/CDC-1234 OR CC-1234' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"propertyAndContactInformation": {
"applicantDetails": {
"fullName": "John Carter",
"email": "testapplicant@yopmail.com"
},
"ownerDetails": {
"fullName": "John Carter",
"email": "testapplicant@yopmail.com",
"address": {
"gurasID": 2636480,
"fullAddress": "68 CROWN STREET RIVERSTONE 2765"
},
"contactNumber": 434340748,
"licenseNumber": "cr513631"
},
"siteAddress": {
"gurasID": 2636480,
"fullAddress": "68 CROWN STREET RIVERSTONE 2765"
},
"descriptionOfDevelopment": "This site is under the development activity of character."
},
"missedInspectionDetails": {
"dateOfInspection": "2024-02-21",
"missedInspectionComments": "string",
"inspectionType": "Footings",
"otherInspectionTypeDetails": "Provides the details when the inspectiontype is otherinspection",
"notesFromInspection": "A high-level notes provided by the certifier with details of the missed inspection. Details to include the circumstances that the principal certifier considers were unavoidable and caused it to be missed and that the work that would have been the subject of the missed inspection is satisfactory."
},
"certifierDetails": {
"principalCertifierDetails": {
"accreditationNo": "BDC1234 OR AMR-123456",
"fullName": "John Smith"
}
},
"documentaryEvidence": "These are the list of supporting documents, and here is a description of the documents, also these are he necessary comments on the evidence.",
"documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Case has been created successfully.", "caseID": "INSP-2788 or WDN-2345", "activityId": "string", "Documents": [ { … } ] }
Request
This operation transfers the certifier's Written Direction Notice(WDN) PART A -information from the certifier's IT system to the ePlanning portal. This operation is applicable for Complying Development Certificate (CDC) and Construction Certificate (CC) applications and it is available only after the determination stage. By performing this operation, the certifier confirms that all relevant legislative requirements have been considered and adhered to. Reference data values can be obtained from the reference data API using the PCC or CDC digital service along with the corresponding operation.
Headers
Bodyapplication/jsonrequiredThe council LGA name or Private Certifier Organisation name to indicate where the request is originated from.
body
This is to track the name of the developer responsible for the aspect of development. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
Example: "John Carter"
This is to track the email ID of the developer responsible for the aspect of development. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
Example: "testapplicant@yopmail.com"
This is to track the address. Either gurasID or the fullAddress is required to be supplied. If gurasID is not supplied, then fullAddress will be considered for update. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
This is to track the gurasID which helps to fetch the address from NSW address database (GURAS).
Example: 2636480
This is to track the address. Either gurasID or the fullAddress is required to be supplied. If gurasID is not supplied, then fullAddress will be considered for update. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
This is to track the gurasID which helps to fetch the address from NSW address database (GURAS).
Example: 2636480
This is to track the name of the local council or the consent authority name. Please note, if the attribute's value is already loaded from it's parent case, this is field becomes optional.
Example: "BLACKTOWN CITY COUNCIL"
This is to track the notice issued date. This date should not be prior to the appointment of the principal certifier.
Example: "2024-02-21"
This is to track the person to whom the notice is issued to. Please refer to the reference data API for the latest values. Following are the example values. 1. Land owner 2. Owner builder 3. Principal contractor 4. Other.
Example: "Land owner"
This is to track the description of notice, and is applicable when the notice issued to is 'Other'.
Example: "Other person or organisation to whome the notice is issued."
This is to track the details of the non-complaince.
Example: null
This is to track the steps taken to rectify non-compliance.
Example: null
This is to track the due date for remedy of non-compliance. Date by which the person responsible for the aspect of development must demonstrate that they have remedied the non-compliance.
Example: "2024-02-21"
This is to track the scheduled date when the inspection is proposed to be conducted by the principal certifier. If the non-compliance is not remedied by the inspection date, a notice will be provided to the relevant consent authority and owner within 2 days after the inspection.
Example: "2024-02-21"
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateWDN/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateWDN/CDC-1234 OR CFT-1234' \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"certifierDetails": {
"principalCertifierDetails": {
"accreditationNo": "BDC1234 OR AMR-123456",
"fullName": "John Smith",
"email": "pc@dpie.com",
"mobileNumber": 434340789
}
},
"propertyAndContactInformation": {
"developerDetails": {
"fullName": "John Carter",
"email": "testapplicant@yopmail.com",
"address": {
"gurasID": 2636480,
"fullAddress": "68 CROWN STREET RIVERSTONE 2765"
}
},
"ownerDetails": {
"fullName": "John Carter"
},
"siteAddress": {
"gurasID": 2636480,
"fullAddress": "68 CROWN STREET RIVERSTONE 2765"
},
"consentAuthority": "BLACKTOWN CITY COUNCIL"
},
"noticeDetails": {
"noticeIssuedDate": "2024-02-21",
"noticeIssuedTo": "Land owner",
"noticeIssuedToOtherDesc": "Other person or organisation to whome the notice is issued.",
"nonComplianceDetails": null,
"nonComplianceRemedy": null,
"nonComplianceRemedyDueDate": "2024-02-21",
"inspectionConductDate": "2024-02-21"
},
"documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Case has been created successfully.", "caseID": "INSP-2788 or WDN-2345", "activityId": "string", "Documents": [ { … } ] }
Request
This operation transfers the certifier's Written Direction Notice (WDN) PART B - Inspection information from the certifier's IT system to the ePlanning portal. This operation is applicable for Complying Development Certificate (CDC) and Construction Certificate (CC) applications and it is available only after the determination stage. Reference data values can be obtained from the reference data API using the PCC or CDC digital service along with the corresponding operation.
Headers
Bodyapplication/jsonrequiredThe council LGA name or Private Certifier Organisation name to indicate where the request is originated from..
body
This is to track the parent case id (CFT or CDC) to update part B (Inspection) information of WDN.
Example: "CFT-1234 or CDC-1234"
This is to track the certifier details. Either Principal Certifier Details or the Assigned Individual Certifier Details must be provided.
This is to track the details of the principal certifier and their individual registration details.
certifierDetails.assignedIndividualCertifierDetailsobject(assignedIndividualCertifierDetailsBodyWDN)
This is to track the registration details of the individual certifier if the inspection was carried out by another certifier ( as agreed with the principal certifier). Either the principal certifier or the assigned individual certifier is expected to conduct the inspection and the values to be supplied accordingly.
This is to track the date on which the inspection was performed.
Example: "2023-03-16"
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/UpdateWDN/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/UpdateWDN/WDN-1234 \
-H 'Content-Type: application/json' \
-H 'IdempotencyID: string' \
-H 'OrganisationID: string' \
-d '{
"parentCaseID": "CFT-1234 or CDC-1234",
"certifierDetails": {
"principalCertifierDetails": {
"accreditationNo": "BDC1234 OR AMR-123456",
"fullName": "John Smith"
},
"assignedIndividualCertifierDetails": {
"accreditationNo": "BDC1234 OR AMR-123456",
"fullName": "John Smith",
"email": "pc@dpie.com",
"mobileNumber": 434340789,
"organisationName": "John Smith",
"organisationAddress": "John Smith",
"ABN": "12 345 678 900",
"ACN": "123 456 789"
}
},
"inspectionDetails": {
"dateOfInspection": "2023-03-16",
"WDNComplied": true,
"WDNFailReason": "Detailed description of failure."
},
"documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "john.smith@gmail.com"
}'Response
application/json
{ "statusCode": 200, "message": "Case updated", "activityId": "string", "Documents": [ { … } ] }
Bodyapplication/jsonrequired
This is to track the reasoning for consent authority's initiation of a contribution case. Please refer to the reference data API for the latest values. Example values are 1.Applicable contributions plan found in the planning portal 2.Contributions Case not triggered in Applicant's submission 3.Other
This is to track the detailed reason for a case creation. This is required when manualCaseReason is 'Other'.
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateContribution/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/CreateContribution/{CaseID}' \
-H 'Content-Type: application/json' \
-d '{
"manualCaseReason": "string",
"description": "string",
"updatedByEmail": "string"
}'Response
application/json
{ "statusCode": 200, "caseID": "CON-1104", "message": "Request is successful.", "details": "Inner Exceptions, Stack Trace, Json Schema etc" }
Bodyapplication/jsonrequired
This indicates the steps involved in the contributions case lifecycle. These are given in the sequence as expected by the ePlanning system. To update the values for any step, the respective stepName and all corresponding data should be sent. Please refer to the reference data API for the latest values. Example values are 1.PlanAndDevelopment , 2.TotalUnits , 3.CalculateContribution , 4.FinaliseContribution .
This is to track whether the consent authority has chosen to override automatically identified contributions plans. This attribute is applicable when stepName = 'PlanAndDevelopment' and unapplicable for other steps. When true is provided, plans sent by consent authority will be considered for processing. When false is provided, plans sent by consent authority will be ignored. When case is initiated by consent authority manually or via CreateContribution request to ePlanning system, this is not applicable and will be ignored.
This is to track the reason why consent authority chooses to override the system identified contributions plans. This is applicable and required for stepName = 'PlanAndDevelopment' and when isOverridePlans = true. It will be ignored for any other stepName. When case is initiated by consent authority, this is not applicable and will be ignored. Please refer to the reference data API for the latest values. Example values are - 1.New, revised contributions framework(s) apply 2.Different contributions framework(s) apply 3.Additional contributions framework(s) apply 4.Other
This indicates the detailed description for overriding the plans. This is applicable and required for stepName = 'PlanAndDevelopment' when isOverridePlans = true & planOverrideReason = Other. It will be ignored for any other stepName. When case is initiated by consent authority, this is not applicable and will be ignored.
This is to track the list of contribution plan identifiers. It is applicable and required for stepName = 'PlanAndDevelopment' & when isOverridePlans = true. This will be ignored for any other stepName. This is also required when case is initiated by consent authority manually or via CreateContribution request to ePlanning. Please refer to the reference data API for the latest values.
This is to track the previous arrangements which may impact contributions for new development. This attribute is applicable when stepName = 'PlanAndDevelopment' and will be ignored for any other stepName. Example values are - 1.Previous payment made for state contributions, 2.State planning agreement applies to the development.
This is to track if consent authority has chosen to update development inputs provided by applicant. This attribute is applicable when stepName = 'PlanAndDevelopment' and will be ignored for any other stepName. When true is provided, development details shared by consent authority will be considered for processing. When false is provided, development details shared by consent authority will be ignored. When case is initiated by consent authority manually or via CreateContribution request to ePlanning system, this is not applicable and will be ignored.
This is applicable when stepName = 'PlanAndDevelopment' and isOverrideApplicantInputs is 'true' and will be ignored for any other stepName. If consent authority does not provide any data for this condition then ePlanning system processes data if provided by the applicant for this case. Please refer to the reference data API for the latest values.
This is to track the number of stages of development in a Contribution case. This is applicable and required when stepName = 'PlanAndDevelopment' OR 'TotalUnits' OR 'CalculateContribution'. Note- multiple stages are not applicable under a Complying Develoment Certificate parent application.
This is applicable and required when stepName = 'FinaliseContribution'. By providing 'true' for this attribute, consent authority is agreeing to all required declaration on the Housing and Productivity contribution calculation and accompanying documents is correct. The case will be closed and contribution details cannot be changed or revised once this attribute is submitted as 'true'.
This is applicable for all the steps and not mandatory. But, please note that for StepName = 'PlanAndDevelopment', previousContributionsInformation is required to upload a document and for stepName = 'CalculateContribution', assessedAmount should be greater than $0.00 to upload a document.
https://api-uat.apps1.nsw.gov.au/planning/Common/v2/UpdateContribution/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-uat.apps1.nsw.gov.au/planning/Common/v2/UpdateContribution/{CaseID}' \
-H 'Content-Type: application/json' \
-d '{
"stepName": "string",
"isOverridePlans": true,
"planOverrideReason": "string",
"planOverrideReasonDescription": "string",
"contributionPlans": [
{
"planId": "string"
}
],
"previousContributionInformation": [
"string"
],
"isOverrideApplicantInputs": true,
"proposedDevelopment": [
{
"developmentCategory": "string",
"developmentTypes": [
{
"developmentType": "string"
}
]
}
],
"stages": [
{
"proposedDevelopmentUses": [
{
"planId": "string",
"developmentType": "string",
"unitOfCharge": "string",
"totalUnits": 0
}
],
"isExistingDevelopment": true,
"existingDevelopment": [
{
"developmentCategory": "string",
"developmentTypes": [
{
"developmentType": "string"
}
]
}
],
"existingDevelopmentUses": [
{
"planId": "string",
"developmentType": "string",
"unitOfCharge": "string",
"totalUnits": 0
}
],
"contributionAssessmentDetails": [
{
"planId": "string",
"assessedAmount": 0,
"timingOfPayment": "string",
"assessedAmountReason": "string"
}
],
"assessedAmountReasonDescription": "string"
}
],
"isFinaliseContribution": true,
"documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com"
}
],
"updatedByEmail": "string"
}'Response
application/json
{ "statusCode": 200, "message": "Request is successful.", "activityId": "CON-1104", "details": "Inner Exceptions, Stack Trace, Json Schema etc" }