Common - Outbound from ePlanning API
Common - Outbound from ePlanning API (v2)
https://dpie-apim-prod.redocly.app/
Information request object
This field is to track the case status of the additional information request
This is to track the date on which additional information is provided.
https://dpie-apim-prod.redocly.app/UpdateAdditionalInfo/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://dpie-apim-prod.redocly.app/UpdateAdditionalInfo/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyId: string' \
-H 'OrganisationID: string' \
-d '{
"caseStatus": "Complete",
"childCaseID": "string",
"responseDate": "2019-08-24",
"responseDetails": "string",
"documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com",
"documentSize": 0,
"updatedBy": "Council"
}
],
"updatedBy": {
"person": {
"firstName": "John",
"familyName": "Smith",
"email": "john.smith@gmail.com",
"contactNumber": "stringst"
}
}
}'
Information request object
https://dpie-apim-prod.redocly.app/Reassign/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://dpie-apim-prod.redocly.app/Reassign/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyId: string' \
-H 'OrganisationID: string' \
-d '{
"assignee": {
"person": {
"firstName": "John",
"familyName": "Smith",
"email": "john.smith@gmail.com",
"contactNumber": "stringst"
}
},
"updatedBy": {
"person": {
"firstName": "John",
"familyName": "Smith",
"email": "john.smith@gmail.com",
"contactNumber": "stringst"
}
}
}'
https://dpie-apim-prod.redocly.app/Documents/{DocID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://dpie-apim-prod.redocly.app/Documents/{DocID}' \
-H 'OrganisationID: string'
This is to track the application submission type. 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
This indicates the PAN case number under which the exhibition and its submission cases are created.
This is to track the government agency/authority for whom it was submitted. 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'
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 in the address. 1. Australian Capital Territory 2. New South Wales 3. Northern Territory 4. Queensland 5. South Australia 6. Tasmania 7. Victoria 8. Western Australia
This is to track if the person who submits has any political donations to report.
This is to track the submission consent. 1. I support it 2. I object to it 3. I am just providing comments
This is mandatory field user need to accept terms and conditions.
https://dpie-apim-prod.redocly.app/CreateSubmission/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://dpie-apim-prod.redocly.app/CreateSubmission/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyId: string' \
-H 'OrganisationID: string' \
-d '{
"submissionType": "Refer to description for values",
"parentCaseID": "string",
"exhibitionCaseID": "string",
"organisationName": "string",
"positionInOrganisation": "string",
"title": "Mr",
"firstName": "string",
"familyName": "string",
"nameWithheld": true,
"email": "string",
"address1": "string",
"address2": "string",
"suburbTownPostcode": "string",
"postCode": "string",
"state": "Refer to description for values",
"reportablePoliticalDonation": true,
"submissionConsent": "Refer to description for values",
"submission": "string",
"declarations": [
"I agree to the Privacy statement",
"I have read and understood the above",
"I understand that by clicking the \"Submit\" button, I am providing the information contained in this form to the Department of Planning and Environment and confirm that that information is not false or misleading"
],
"documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com",
"documentSize": 0,
"updatedBy": "Council"
}
]
}'
https://dpie-apim-prod.redocly.app/ExhitbitionStatusUpdate/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://dpie-apim-prod.redocly.app/ExhitbitionStatusUpdate/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyId: string' \
-H 'OrganisationID: string' \
-d '{
"caseStatus": "Complete"
}'
Information request object
This is to track the application status.
This is to track the date on which the case is withdrawn.
https://dpie-apim-prod.redocly.app/Withdraw/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://dpie-apim-prod.redocly.app/Withdraw/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyId: string' \
-H 'OrganisationID: string' \
-d '{
"caseStatus": "Submitted",
"withdrawalDate": "2019-08-24",
"withdrawalReason": "string",
"documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com",
"documentSize": 0,
"updatedBy": "Council"
}
],
"updatedBy": {
"person": {
"firstName": "John",
"familyName": "Smith",
"email": "john.smith@gmail.com",
"contactNumber": "stringst"
}
}
}'
Information request object
This child case ID is to track the additional information request.
https://dpie-apim-prod.redocly.app/RequestAddInfo/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://dpie-apim-prod.redocly.app/RequestAddInfo/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyId: string' \
-H 'OrganisationID: string' \
-d '{
"childCaseID": "AI-XXXX",
"caseStatus": "string",
"requestDate": "2019-08-24",
"requestDetails": "string",
"documents": [
{
"documentName": "string",
"documentType": "string",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "http://example.com",
"documentSize": 0,
"updatedBy": "Council"
}
],
"updatedBy": {
"person": {
"firstName": "John",
"familyName": "Smith",
"email": "john.smith@gmail.com",
"contactNumber": "stringst"
}
}
}'
Request
This operation provides the NOD document's generation status and review letter generation status for review DA cases along with the document details to the consent authority. This operation also provides all the conditions used to generate the NOD for that case. For any Bespoke conditions which are not present in the DPE Council library, this API will assign a case specific Condition ID. This Condition ID should be stored for that case in the council system. This Condition ID should be passed in ConsentConditions API during Mod and Review of a DA if the same condition needs to be retained.
NotificationOfNODStatus request object
This indicates the reason as to why the NOD document generation is failed.This is relevant for NOD failure scenarios only.
https://dpie-apim-prod.redocly.app/NotificationOfNODStatus/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://dpie-apim-prod.redocly.app/NotificationOfNODStatus/{CaseID}' \
-H 'Content-Type: application/json' \
-H 'IdempotencyId: string' \
-H 'OrganisationID: string' \
-d '{
"NODGenenerationStatus": "Success",
"documents": [
{
"documentName": "NoticeOfDetermination.pdf",
"documentType": "Notice of determination",
"uploadedDateTime": "2019-08-24T14:15:22Z",
"documentURL": "Document URL",
"updatedBy": "abc@gmail.com"
}
],
"failureReason": "Condition'\''s validation faliure text",
"conditions": [
{
"conditionID": "COND-123",
"conditionType": "Bespoke",
"conditionTitle": "Approved Plans",
"conditionText": "<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>",
"conditionReason": "Plans condition.",
"modificationReason": "Condition modified to change the hours of operation",
"typeOfWork": "Demolition work",
"developmentStage": "General condition.",
"councilConditionID": "SAMPLE-123"
}
]
}'
{ "statusCode": 200, "message": "Request is successfully executed" }
The request payload for the create contribution.
This indicates the parent case ID of the Contributions case. Possible formats are PAN-xxxxx or CDC-xxxxx.
This is to track the previous arrangements which may impact contributions for new development.
This is to track the plan details used for Contributions case creation. Please refer to the reference data API for the latest values.
This is to track the unique plan identifier that was applicable for Contributions case creation.
This is to track the name of the contributions plan that was applicable for Contributions case creation.
This is to track the proposed development details that were submitted in the application. Please refer to the reference data API for the latest values.
This is to track the number of stages proposed by the applicant during application submission. The object repeats as many times as the number of stages. Note- multiple stages are not applicable under a Complying Develoment Certificate parent application.
https://dpie-apim-prod.redocly.app/CreateContribution/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://dpie-apim-prod.redocly.app/CreateContribution/{CaseID}' \
-H 'Content-Type: application/json' \
-d '{
"caseStatus": "In-progress",
"parentCaseID": "PAN-XXXXX",
"previousContributionInformation": [
"Previous payment made for state contributions",
"State planning agreement applies to the development"
],
"contributionPlans": [
{
"planId": "STIC-100000000123",
"planName": "Greater Sydney State Infrastructure Contributions11",
"planStatus": "In effect"
}
],
"proposedDevelopment": [
{
"developmentCategory": "Agriculture",
"developmentTypes": [
{
"developmentType": "Aquaculture"
}
]
}
],
"stages": [
{
"proposedDevelopmentUses": [
{
"planId": "STIC-100000000123",
"developmentType": "Dwelling houses",
"unitOfCharge": "total no. of dwelling",
"totalUnits": 3
}
],
"isExistingDevelopment": "yes",
"existingDevelopment": [
{
"developmentCategory": "Agriculture",
"developmentTypes": [
{
"developmentType": "Aquaculture"
}
]
}
],
"existingDevelopmentUses": [
{
"planId": "STIC-100000000123",
"developmentType": "Dwelling houses",
"unitOfCharge": "total no. of dwelling",
"totalUnits": 44
}
]
}
],
"documents": {
"documentType": "test.docx",
"uploadedDateTime": "2019-08-24T14:15:22.0000000+00:00",
"documentURL": "https://api-tst.apps1.nsw.gov.au/planning/external/v1/Documents/Doc2",
"documentSize": 0,
"updatedBy": "System Generated"
}
}'
{ "statusCode": 200, "message": "Request is successfully executed" }
This is to track the spatial layers intersecting with site address. Example values are - 1.Note: The site, or part of the site, is located within a rural zone.; 2. The site, or part of the site, is located within a Special Infrastructure Contributions Area. Consult the Department of Planning and Environment to determine how this affects State infrastructure contributions. Please go to this link for an estimation under existing Special Infrastructure Contributions frameworks.; 3.Note: The site, or part of the site, is located within the lease area as identified in the SEPP (Three Ports) 2013 Lease Area Map.
This is to track the plan details applied for contributions calculation. Please refer to the reference data API for the latest values.
This is to track the unique plan identifier applicable in the Contributions case
This is to track the name of the contributions plan that was applicable in Contributions case
This is to track the previous arrangements which may impact contributions for new development.
This is to track the proposed development details that were submitted in the application. Please refer to the reference data API for the latest values.
This is to track the number of stages proposed by the applicant during application submission. The object repeats as many times as the number of stages. Note- multiple stages are not applicable under a Complying Develoment Certificate parent application.
This is to track the list of documents provided during Contributions case creation.
https://dpie-apim-prod.redocly.app/UpdateContribution/{CaseID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://dpie-apim-prod.redocly.app/UpdateContribution/{CaseID}' \
-H 'Content-Type: application/json' \
-d '{
"caseStatus": "Resolved-",
"additionalInformation": [
"This site is in a rural zone",
"This is in SIC zone"
],
"contributionPlans": [
{
"planId": "STIC-100000000123",
"planName": "Greater Sydney State Infrastructure Contributions11",
"planStatus": "In effect"
}
],
"previousContributionInformation": [
"Previous payment made for state contributions",
"State planning agreement applies to the development"
],
"proposedDevelopment": [
{
"developmentCategory": "Agriculture",
"developmentTypes": [
{
"developmentType": "Aquaculture"
}
]
}
],
"stages": [
{
"proposedDevelopmentUses": [
{
"planId": "STIC-100000000123",
"developmentType": "Dwelling houses",
"unitOfChargeName": "total no. of dwelling",
"indexedRate": 0,
"calculatedAmount": 14760,
"currentIndexationPeriod": "2022-06-01",
"currentIndexationValue": 102,
"baseIndexationValue": 90,
"totalUnits": 1
},
{
"planId": "STIC-100000000123",
"developmentType": "Group homes (transitional) or transitional group homes",
"unitOfChargeName": "total no. of dwelling",
"indexedRate": 0,
"calculatedAmount": 49200,
"currentIndexationPeriod": "2022-06-01",
"currentIndexationValue": 102,
"baseIndexationValue": 90,
"totalUnits": 4
}
],
"isExistingDevelopment": "yes",
"existingDevelopment": [
{
"developmentCategory": "Agriculture",
"developmentTypes": [
{
"developmentType": "Aquaculture"
}
]
}
],
"existingDevelopmentUses": [
{
"planId": "STIC-100000000123",
"developmentType": "Dwelling houses",
"unitOfChargeName": "total no. of dwelling",
"indexedRate": 0,
"calculatedAmount": 14760,
"currentIndexationPeriod": "2022-06-01",
"currentIndexationValue": 102,
"baseIndexationValue": 90,
"totalUnits": 4
},
{
"planId": "STIC-100000000123",
"developmentType": "Group homes (transitional) or transitional group homes",
"unitOfChargeName": "total no. of dwelling",
"indexedRate": 0,
"calculatedAmount": 49200,
"currentIndexationPeriod": "2022-06-01",
"currentIndexationValue": 102,
"baseIndexationValue": 90,
"totalUnits": 4
}
],
"calculationSummary": [
{
"planName": "Greater Sydney State Infrastructure Contributions Location Based",
"planId": "LBSC-100000000123",
"timingOfPayment": "Subdivision certificate",
"assessedAmount": 23,
"contributionsAmount": 23,
"assessedAmountReason": "Other",
"assessedAmountReasonDescription": "Description of reason when we select '\''other'\'' for assessedAmountReason",
"systemCalculatedAmount": 108240
},
{
"planName": "Greater Sydney State Infrastructure Contributions Location Based6232",
"planId": "LBSC-10000516232",
"timingOfPayment": "Subdivision certificate",
"assessedAmount": 23,
"contributionsAmount": 23,
"assessedAmountReason": "Other",
"assessedAmountReasonDescription": "Description of reason when we select '\''other'\'' for assessedAmountReason",
"systemCalculatedAmount": 108240
}
]
}
],
"documents": [
{
"documentName": "test.docx",
"documentType": "Determination",
"uploadedDateTime": "2019-08-24T14:15:22.0000000+00:00",
"documentSize": "",
"uploadedBy": "",
"documentURL": "https://api-tst.apps1.nsw.gov.au/planning/external/v1/Documents/Doc2"
}
],
"updatedBy": {
"firstName": "John",
"familyName": "Smith",
"email": "john.smith@gmail.com",
"contactNumber": "23802123222"
}
}'
{ "statusCode": 200, "message": "Request is successfully executed" }