Skip to content

CDC - ePlanning to Certifier 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/

CreateCDC

Request

This operation transfers the CDC application created by the applicant from the Online CDC Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

The council LGA name or Private Certifier Organisation name to indicate where the response is routed to.

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

caseStatusstring[ 1 .. 80 ] charactersrequired

Status of the CDC case

Example: "Submitted"
contributionDetailsArray of objects(contributionDetails)

This is to track the infrastructure contribution's case details associated to the development.

applicantobject(Applicant)required
applicant.​titlestring(Title)

One of the below mentioned values must be selected for Title 1. Miss 2. Mr 3. Mrs 4. Ms

Example: "Refer to description for values"
applicant.​applicantPersonobject(Person)required
applicant.​applicantPerson.​firstNamestring[ 1 .. 20 ] charactersrequired
applicant.​applicantPerson.​otherNamestring<= 20 characters
applicant.​applicantPerson.​familyNamestring[ 1 .. 20 ] charactersrequired
applicant.​applicantPerson.​contactNumberstring[ 8 .. 10 ] characters^[0-9]+$
applicant.​applicantPerson.​emailstring<= 250 characters
applicant.​addressstring[ 1 .. 250 ] charactersrequired
applicant.​isApplyBehalfOnCompanyboolean

Is applicant applying on behalf of a company

applicant.​isManualEntryboolean

Used to hold manual entry flag for search ABN/ACN

applicant.​applyOnBehalfCompanyobject(Company)
applicant.​nominatedCompanyApplicantboolean

Is the nominated company the applicant for this application

siteAddressesArray of objects(Location)required
siteAddresses[].​addressstring[ 1 .. 250 ] charactersrequired

Address where the development is happening

Example: "19-33 Elizabeth Street, Narrandera, 2700"
siteAddresses[].​addressDetailobject(AddressDetail)
siteAddresses[].​lotListArray of objects(LotSectionPlan)
siteAddresses[].​lgastring[ 1 .. 30 ] charactersrequired

Local Government Area under which this case falls

Example: "PENRITH"
siteAddresses[].​isPrimaryboolean

The primary address if multiple

relatedCasesArray of objects(RelatedCases)
ownershipstring(Ownership)non-emptyrequired

Who owns the development site? One of the below mentioned values must be selected for ownership 1. I am the sole owner of the development site 2. There are multiple owners of the development site and I am one of them 3. There are multiple owners of the development site and I am NOT one of them 4. A company, business, government entity or other similar body owns the development site

Example: "Refer to description for values"
typeOfBuilderstring

This is to track the type of builder undertaking the building work. 1.Licensed Builder 2.Owner Builder 3.Not determined at this time(This information will be required prior to work commencing)

Example: "Refer to description for values"
builderOrPrincipalContractorDetailsArray of objects(BuilderOrPrincipalContractorDetails)

This is to track the builder or Principal Contractor details.

ownerDetailsArray of objects(OwnerDetails)

Must include either a ownerPerson or ownerCompany

ownersConsentDeclarationstring

I declare that I have shown this document, including all attached drawings, to the owner(s) of the land, and that I have obtained their consent to submit this application. This is visible when OwnersDetails visible except when we select developmentSiteOwner as I am the sole owner of the development site

securityConditionsboolean

Used to hold Are there any security or site conditions which may impact on the person undertaking the inspection or not .

detailsOfSecurityConditionsstring

Need to hold the details when we select Are there any security or site conditions which may impact on the person undertaking the inspection is true.

developerDetailsobject(developerDetails)

Used to hold the developer details.

payerInformationobject
applicationTypestring

One of the below mentioned values must be selected for applicationType 1. Complying development certificate application 2. Modification to complying development certificate.

Example: "Refer to description for values"
isPatternBookApplicationboolean

This is used to track whether the application is proceeding under the NSW Housing Pattern Book fast-track assessment pathway.

patternIDstring<= 32 characters

This is used to track the Pattern Book Identification Number as provided in the NSW Housing Design Verification Statement (Example - 1111-SD01, 1234-MH01, 1432-TH04001). This is required when the application is flagged as a Pattern Book submission.

isDuplicatePatternIDboolean

This is used to track whether the same Pattern Book Identification Number has been previously used in any CDC application, in order to identify potential duplicates and enforce submission rules.

determinedNotifiedstring(date)

Date when the MODIFICATION was determined.

Example: "2020-12-02"
caseSubmittedDatestring(date)

This is to track the date when the applicant submitted the application.

isPoolSpa40KlitersProposedboolean

This is to track if the pool is more than 40K in capacity. This question is applicable for the development type 'Swimming pools'.

DANumberstring<= 20 characters

Required if the applicationType is MODIFICATION

proposedModificationDescriptionstring<= 1500 characters

Required if the applicationType is MODIFICATION

hasCDCOnlinecaseboolean

This field is to capture the answer (Yes/No) for the question 'Was the CDC applied for via the NSW planning portal?' during the 'modification to complying development certificate'

CDCportalReferenceNumberstring

This field is to capture the CDC's portal application number that's provided by the applicant for modification application.

commonApplicationTypesArray of objects(CommonApplicationType)required

This is to track the common Application types. Example values are 1. Advertising and signage 2. Alterations or additions to an existing building or structure 3. Change of use of land or a building or the classification of a building under the Building Code of Australia 4. Demolition 5. Erection of a new structure 6. Hours of operation and trading 7. Subdivision 8. Temporary building, structure or use

commonApplicationTypes[].​commonApplicationTypestring
subdivisionTypesArray of strings

This is to track the appropriate subdivision types. This is applicable when 'Subdivision' is one of the common application type('commonApplicationTypes'). Example values are 1. Strata Title 2. Community Title 3. Torrens Title 4. Stratum Title

numOfExistingLotsinteger

This is to track the number of existing lots. This is applicable when 'Subdivision' is one of the common application types('commonApplicationTypes').

numOfProposedLotsinteger

This is to track the number of proposed lots. This is applicable when 'Subdivision' is one of the common application types('commonApplicationTypes').

developmentTypesArray of objects(DevelopmentType)
descriptionOfWorkstring

Used to hold the a detailed description of the development.For example Demolition of existing buildings, construction of a single storey dwelling, swimming pool and related landscaping.

isPreviousDevelopmentConsentSubmittedboolean

This is to track if the previous development consent (DA/CDC) application been submitted for building work. This is applicable when the common application type is Subdivision.

isPreviousApplicationSubmittedViaPortalboolean

This is to track if the previous development consent (DA/CDC) application applied for via the NSW Planning Portal. This is applicable when the common application type is Subdivision.

previousDevelopmentConsentCaseIDstring

This is to track the NSW Planning Portal application number (CDC or PAN). This is applicable when the common application type is Subdivision and when the isPreviousDevelopmentConsentSubmitted is true.

isDevelopmentExemptfromDBPActboolean

This is an obsolete attribute and will not be entered by the applicant anymore. Tracks if the the development is exempted from Design and Building Practitioners Act 2020. This is applicable for any development type under group term 'Residential Accommodation' in conjunction with the common application type value 'Alterations or additions to an existing building or structure'.

developmentExemptReasonstring<= 512 characters

This is an obsolete attribute and will not be entered by the applicant anymore. This is to track the reason as to why the development is exempted from Design and Building Practitioners Act 2020. Applicable when 'Yes' is chosen for the question 'Is the development exempt from Design and Building Practitioners Act 2020 ?' (isDevelopmentExemptfromDBPAct). The reason provided when 'Other' value is chosen by the user will be captured in this tag itself with a delimiter. ( e.g - Other-Reasonvalue) 1. Labour and materials value less than AUD $5000 2. Under homebuilder grant 3. Under a council order 4. Under development control order 5. Maintaining fire safety system 6. Exempt from BCA under clause 164B, 187 or 188 7. Maintaining a building component of a system 8. Exempt under environmental planning 9. Fit out only 10. Other

proposed24HrWorkobject(ScheduleWorkDay)

This is to track the proposed hours of work when applicable.

isNaturalDisasterstring

Used to hold whether the application the direct result of a matter declared by the government to be an emergency and/or a natural disaster or not .

estimatedAreaOfAsbestosMaterialstring(decimal)non-empty

Used to Estimate of the area (if any) in square meters of bonded asbestos material or friable asbestos material that will be disturbed, repaired or removed in the carrying out of the development (m2)

estimatedCoststring(decimal)

This is to track the estimated development cost, including GST.

lotTypestringnon-empty

One of the below mentioned values must be selected for lotType 1. Corner lot 2. Parallel road lot 3. Battle-axe lot 4. Standard lot

Example: "Refer to description for values"
haveMoreBasixboolean

This is to track if the applicant has one or more BASIX certificates when applicable.

basixCertificateNumberArray of objects(BasixCertificateNumber)
referencePlanningCertificateNumberstring

Please enter 10.7 certificate number related to this application."This is mandatory when Was the 10.7 certificate applied for via the NSW Planning Portal? is false"

certificate10.7Obtainedboolean

Have you already obtained a 10.7 certificate?

has10.7Onlinecaseboolean

This field is mandatory when "certificate10.7Obtained" this is true. Was the 10.7 certificate applied for via the NSW Planning Portal?

portalReferenceNumberstring<= 1500 characters

Please provide portal reference number. and this field is mandatory when 'has10.7Onlinecase' is true.

registeredCertifierOrgDetailsobject(registeredCertifierOrgDetails)

This indicates the organisation details of the nominated Registered certifier.

principalCertifierOrgDetailsobject(principalCertifierOrgDetails)

This indicates the organisation details of the nominated Principal certifier.

certifierOrgDetailsobject

This contains Nominated Certifier details. This is obsolete and is replaced by the relevant registeredCertifierOrgDetails & principalCertifierOrgDetails object.

isS68LGActApprovalReqboolean

Is approval under s68 of the Local Government Act 1993 required?

isS68Appliedboolean

When 'IsS68LGActApprovalReq' is true this field is mandatory. Have you already applied for approval under s68 of the Local Government Act?

applyS68Approvalboolean

Would you like to apply for approval under s68 of the Local Government Act? Applicable when -Have you already applied for approval under s68 of the Local Government Act? is "false" and address falls under same CouncilForS68

startPlanningCertificateApplicationboolean

Would you like to start a Planning Certificate 10.7 application?. Applicable when Have you already obtained a 10.7 certificate? is "false" and address falls under same council For PC107. it will have true or false as values

hasOnlines68Caseboolean

When 'IsS68Applied' is true this field is mandatory. Was the s68 certificate applied for via the NSW Planning Portal?

s68ReferenceNumberstring<= 1500 characters

Please provide portal reference number. and this field is mandatory when 'HasOnlines68Case' is true.

s68RelatedRefNostring

Please enter s68 reference number related to this application. and this field is mandatory when 'HasOnlines68Case' is false.

isResendboolean

This is to track if application details are resent. True indicates a retriggered event.

documentsArray of objects(DownloadableDocument)
buildingPractitionerArray of objects(buildingpractitioner)

This is an obsolete attribute and will not be entered by the applicant anymore. List of Building Practitioner. Providing the details of the Registered Practitioner for certain developments will become visible in the future. This requirement will apply where all or part of the development falls within Class 2 of the Building Code of Australia.

designpractitionerArray of objects(designpractitioner)

This is an obsolete attribute and will not be entered by the applicant anymore. List of engineers. Providing the details of the Registered Practitioner for certain developments. This requirement will apply where all or part of the development falls within Class 2 of the Building Code of Australia.

principaldesignpractitionerArray of objects(principaldesignpractitioner)

This is an obsolete attribute and will not be entered by the applicant anymore. List of Designer. Providing the details of the Registered Practitioner for certain developments will become visible in the future. This requirement will apply where all or part of the development falls within Class 2 of the Building Code of Australia.

employeeDeclarationboolean

Are you an employee / Councillor or relative of an employee / Councillor within the same local government area as the proposed development?

natureOfRelationshipstring

Nature of relationship. One of the below mentioned values must be selected for natureOfRelationship 1. I am an employee 2. I am a councillor 3. I am a relative of, or relationship with, employee or Councillor

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

It will hold the date of the Building work commencement. This will be passed when the applicant performs IntentionToCommenceWork local action

isExistingCemeteryboolean

This is to track if the application is for an existing cemetery. This question is applicable and mandatory when the development type is Cemetery.

isStateHeritageRegisteredboolean

This is to track if the development to be carried out on land that is listed on the State Heritage Register under the Heritage Act 1977. This question is applicable and mandatory when the development type is Cemetery.

isSubjectToInterimHeritageOrderboolean

This is to track if the development to be carried out on land that is subject to an interim heritage order. This question is applicable and mandatory when the development type is Cemetery.

isEnvironmentalHeritageboolean

This is to track if the development to be carried out on land that is identified as an item of environmental heritage. This question is applicable and mandatory when the development type is Cemetery.

isActiveCemeteryboolean

This is to track if the application is for an active cemetery (i.e., accepting new burials). This question is applicable and mandatory when the development type is Cemetery.

declarationsArray of strings(declarations)

Declarations for CDC

Example: ["Refer to description for values"]
curl -i -X POST \
  'https://api-uat.apps1.nsw.gov.au/planning/CreateCDC/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "contributionDetails": [
      {
        "caseID": "CON-5453",
        "status": "In-progress"
      }
    ],
    "applicant": {
      "title": "Refer to description for values",
      "applicantPerson": {
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "string"
      },
      "address": "string",
      "isApplyBehalfOnCompany": true,
      "isManualEntry": true,
      "applyOnBehalfCompany": {
        "companyName": "string",
        "tradeName": "string",
        "ABN": "string",
        "ACN": "string"
      },
      "nominatedCompanyApplicant": true
    },
    "siteAddresses": [
      {
        "address": "19-33 Elizabeth Street, Narrandera, 2700",
        "addressDetail": {
          "complexUnitType": "string",
          "complexLevelType": "string",
          "complexLevelNumber": "string",
          "complexUnitIdentifier": "string",
          "streetNumber1": "string",
          "streetNumber2": "string",
          "streetName": "string",
          "streetSuffix": "string",
          "streetType": "string",
          "suburb": "string",
          "latitude": 0,
          "longitude": 0,
          "wkid": "string",
          "cadastralID": "string",
          "gurasID": "string",
          "primarySecondary": "string",
          "state": "string",
          "postCode": 0
        },
        "lotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX"
          }
        ],
        "lga": "PENRITH",
        "isPrimary": true
      }
    ],
    "relatedCases": [
      {
        "relatedCase": "string"
      }
    ],
    "ownership": "Refer to description for values",
    "typeOfBuilder": "Refer to description for values",
    "builderOrPrincipalContractorDetails": [
      {
        "builderType": "Refer to description for values",
        "builderPerson": {
          "title": "string",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string",
          "licenseNumber": "string"
        },
        "builderCompany": {
          "company": {
            "companyName": "string",
            "ABN": "string",
            "ACN": "string",
            "tradingName": "string"
          },
          "address": "string",
          "email": "string"
        }
      }
    ],
    "ownerDetails": [
      {
        "isOwnerABuilder": true,
        "title": "Refer to description for values",
        "ownerPerson": {
          "firstName": "John",
          "otherName": "Darren",
          "familyName": "Smith",
          "email": "john.smith@gmail.com",
          "contactNumber": "stringst"
        },
        "ownerCompany": {
          "companyName": "string",
          "ABN": "string"
        },
        "address": "19-33 Elizabeth Street, Narrandera, 2700"
      }
    ],
    "ownersConsentDeclaration": "string",
    "securityConditions": true,
    "detailsOfSecurityConditions": "string",
    "developerDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "emailAddress": "john.smith@gmail.com"
    },
    "payerInformation": {
      "payerType": "Refer to description for values",
      "payerPerson": {
        "title": "Refer to description for values",
        "payerInfo": {
          "firstName": "John",
          "otherName": "Darren",
          "familyName": "Smith",
          "email": "john.smith@gmail.com",
          "contactNumber": "string"
        },
        "billingAddress": "string"
      },
      "payerCompany": {
        "applicantCompany": {
          "companyName": "string",
          "ABN": "string",
          "ACN": "string",
          "tradingName": "string"
        },
        "mailingAddress": "string",
        "email": "string"
      }
    },
    "applicationType": "Refer to description for values",
    "isPatternBookApplication": true,
    "patternID": "string",
    "isDuplicatePatternID": true,
    "determinedNotified": "2020-12-02",
    "caseSubmittedDate": "2019-08-24",
    "isPoolSpa40KlitersProposed": true,
    "DANumber": "string",
    "proposedModificationDescription": "string",
    "hasCDCOnlinecase": true,
    "CDCportalReferenceNumber": "string",
    "commonApplicationTypes": [
      {
        "commonApplicationType": "string"
      }
    ],
    "subdivisionTypes": [
      "string"
    ],
    "numOfExistingLots": 0,
    "numOfProposedLots": 0,
    "developmentTypes": [
      {
        "developmentType": "Dwelling house"
      }
    ],
    "descriptionOfWork": "string",
    "isPreviousDevelopmentConsentSubmitted": true,
    "isPreviousApplicationSubmittedViaPortal": true,
    "previousDevelopmentConsentCaseID": "string",
    "isDevelopmentExemptfromDBPAct": true,
    "developmentExemptReason": "string",
    "proposed24HrWork": {
      "isMonWorkDay": true,
      "MonWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isTueWorkDay": true,
      "TueWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isWedWorkDay": true,
      "WedWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isThuWorkDay": true,
      "ThuWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isFriWorkDay": true,
      "FriWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isSatWorkDay": true,
      "SatWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isSunWorkDay": true,
      "SunWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      }
    },
    "isNaturalDisaster": "string",
    "estimatedAreaOfAsbestosMaterial": "string",
    "estimatedCost": "string",
    "lotType": "Refer to description for values",
    "haveMoreBasix": true,
    "basixCertificateNumber": [
      {
        "certificateNumber": "string"
      }
    ],
    "referencePlanningCertificateNumber": "string",
    "certificate10.7Obtained": true,
    "has10.7Onlinecase": true,
    "portalReferenceNumber": "string",
    "registeredCertifierOrgDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "email": "user@example.com"
    },
    "principalCertifierOrgDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "email": "user@example.com"
    },
    "certifierOrgDetails": {
      "certifierOrgName": "string",
      "tradingName": "string",
      "ABN": "string",
      "ACN": "string",
      "certifierOrgAddress": "string"
    },
    "isS68LGActApprovalReq": true,
    "isS68Applied": true,
    "applyS68Approval": true,
    "startPlanningCertificateApplication": true,
    "hasOnlines68Case": true,
    "s68ReferenceNumber": "string",
    "s68RelatedRefNo": "string",
    "isResend": true,
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "buildingPractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "searchBusinessBy": "Refer to description for values",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            {
              "practitionerTypeValue": "Refer to description for values."
            }
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "designpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "designPractitionerType": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "searchBusinessBy": "Refer to description for values",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            {
              "practitionerTypeValue": "Refer to description for values."
            }
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "principaldesignpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "searchBusinessBy": "Refer to description for values",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            {
              "practitionerTypeValue": "Refer to description for values."
            }
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "employeeDeclaration": true,
    "natureOfRelationship": "Refer to description for values",
    "buildingWorkCommencementDt": "2019-08-24",
    "isExistingCemetery": true,
    "isStateHeritageRegistered": true,
    "isSubjectToInterimHeritageOrder": true,
    "isEnvironmentalHeritage": true,
    "isActiveCemetery": true,
    "declarations": [
      "Refer to description for values"
    ]
  }'

Responses

Case Submitted by Applicant

Body
Response
No content

UpdateCDC

Request

This operation transfers the CDC application's updated details from the Online CDC Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

The council LGA name or Private Certifier Organisation name to indicate where the response is routed to.

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

caseStatusstring[ 1 .. 80 ] charactersrequired

Status of the CDC case

Example: "Submitted"
contributionDetailsArray of objects(contributionDetails)

This is to track the infrastructure contribution's case details associated to the development.

applicantobject(Applicant)required
applicant.​titlestring(Title)

One of the below mentioned values must be selected for Title 1. Miss 2. Mr 3. Mrs 4. Ms

Example: "Refer to description for values"
applicant.​applicantPersonobject(Person)required
applicant.​applicantPerson.​firstNamestring[ 1 .. 20 ] charactersrequired
applicant.​applicantPerson.​otherNamestring<= 20 characters
applicant.​applicantPerson.​familyNamestring[ 1 .. 20 ] charactersrequired
applicant.​applicantPerson.​contactNumberstring[ 8 .. 10 ] characters^[0-9]+$
applicant.​applicantPerson.​emailstring<= 250 characters
applicant.​addressstring[ 1 .. 250 ] charactersrequired
applicant.​isApplyBehalfOnCompanyboolean

Is applicant applying on behalf of a company

applicant.​isManualEntryboolean

Used to hold manual entry flag for search ABN/ACN

applicant.​applyOnBehalfCompanyobject(Company)
applicant.​nominatedCompanyApplicantboolean

Is the nominated company the applicant for this application

siteAddressesArray of objects(Location)required
siteAddresses[].​addressstring[ 1 .. 250 ] charactersrequired

Address where the development is happening

Example: "19-33 Elizabeth Street, Narrandera, 2700"
siteAddresses[].​addressDetailobject(AddressDetail)
siteAddresses[].​lotListArray of objects(LotSectionPlan)
siteAddresses[].​lgastring[ 1 .. 30 ] charactersrequired

Local Government Area under which this case falls

Example: "PENRITH"
siteAddresses[].​isPrimaryboolean

The primary address if multiple

relatedCasesArray of objects(RelatedCases)
ownershipstring(Ownership)non-emptyrequired

Who owns the development site?. One of the below mentioned values must be selected for ownership 1. I am the sole owner of the development site 2. There are multiple owners of the development site and I am one of them 3. There are multiple owners of the development site and I am NOT one of them 4. A company, business, government entity or other similar body owns the development site

Example: "Refer to description for values"
typeOfBuilderstring

This is to track the type of builder undertaking the building work. 1.Licensed Builder 2.Owner Builder 3.Not determined at this time(This information will be required prior to work commencing)

Example: "Refer to description for values"
builderOrPrincipalContractorDetailsArray of objects(BuilderOrPrincipalContractorDetails)

This is to track the builder or Principal Contractor details.

ownerDetailsArray of objects(OwnerDetails)

Must include either a ownerPerson or ownerCompany

ownersConsentDeclarationstring

I declare that I have shown this document, including all attached drawings, to the owner(s) of the land, and that I have obtained their consent to submit this application. This is visible when OwnersDetails visible except when we select developmentSiteOwner as I am the sole owner of the development site

securityConditionsboolean

Used to hold Are there any security or site conditions which may impact on the person undertaking the inspection or not .

detailsOfSecurityConditionsstring

Need to hold the details when we select Are there any security or site conditions which may impact on the person undertaking the inspection is true.

developerDetailsobject(developerDetails)

Used to hold the developer details.

payerInformationobject
applicationTypestring

It infers the application type. One of the below mentioned values must be selected for applicationType 1. Complying development certificate application 2. Modification to complying development certificate.

Example: "Refer to description for values"
isPatternBookApplicationboolean

This is to track if the application is Pattern Book based application and this field is mandatory.

patternIDstring<= 32 characters

This is to track Pattern Book Identification number when applicable.

isDuplicatePatternIDboolean

This is to track if the Pattern Book Identification number is duplicate, which was used in any other CDC application before when applicable.

determinedNotifiedstring(date)

Date when the MODIFICATION was determined.

Example: "2020-12-02"
DANumberstring<= 20 characters

Required if the applicationType is MODIFICATION

proposedModificationDescriptionstring<= 1500 characters

Required if the applicationType is MODIFICATION

hasCDCOnlinecaseboolean

This field is to capture the answer (Yes/No) for the question 'Was the CDC applied for via the NSW planning portal?' during the 'modification to complying development certificate'

caseSubmittedDatestring(date)

This is to track the date when the applicant submitted the application.

isPoolSpa40KlitersProposedboolean

This is to track if the pool is more than 40K in capacity. This question is applicable for the development type 'Swimming pools'.

CDCportalReferenceNumberstring

This field is to capture the CDC's portal application number that's provided by the applicant for modification application.

commonApplicationTypesArray of objects(CommonApplicationType)required

This is to track the common Application types. Example values are 1. Advertising and signage 2. Alterations or additions to an existing building or structure 3. Change of use of land or a building or the classification of a building under the Building Code of Australia 4. Demolition 5. Erection of a new structure 6. Hours of operation and trading 7. Subdivision 8. Temporary building, structure or use

commonApplicationTypes[].​commonApplicationTypestring
subdivisionTypesArray of strings

This is to track the appropriate subdivision types. This is applicable when 'Subdivision' is one of the common application type('commonApplicationTypes'). Example values are 1. Strata Title 2. Community Title 3. Torrens Title 4. Stratum Title

numOfExistingLotsinteger

This is to track the number of existing lots. This is applicable when 'Subdivision' is one of the common application types('commonApplicationTypes').

numOfProposedLotsinteger

This is to track the number of proposed lots. This is applicable when 'Subdivision' is one of the common application types('commonApplicationTypes').

developmentTypesArray of objects(DevelopmentType)
descriptionOfWorkstring

Used to hold the a detailed description of the development.For example Demolition of existing buildings, construction of a single storey dwelling, swimming pool and related landscaping.

isPreviousDevelopmentConsentSubmittedboolean

This is to track if the previous development consent (DA/CDC) application been submitted for building work. This is applicable when the common application type is Subdivision.

isPreviousApplicationSubmittedViaPortalboolean

This is to track if the previous development consent (DA/CDC) application applied for via the NSW Planning Portal. This is applicable when the common application type is Subdivision.

previousDevelopmentConsentCaseIDstring

This is to track the NSW Planning Portal application number (CDC or PAN). This is applicable when the common application type is Subdivision and when the isPreviousDevelopmentConsentSubmitted is true.

isDevelopmentExemptfromDBPActboolean

This is an obsolete attribute and will not be entered by the applicant anymore. Tracks if the the development is exempted from Design and Building Practitioners Act 2020.

developmentExemptReasonstring<= 512 characters

This is an obsolete attribute and will not be entered by the applicant anymore. This is to track the reason as to why the development is exempted from Design and Building Practitioners Act 2020. Applicable when 'Yes' is chosen for the question 'Is the development exempt from Design and Building Practitioners Act 2020 ?' (isDevelopmentExemptfromDBPAct). The reason provided when 'Other' value is chosen by the user will be captured in this tag itself with a delimiter. ( e.g - Other-Reasonvalue). 1. Labour and materials value less than AUD $5000 2. Under homebuilder grant 3. Under a council order 4. Under development control order 5. Maintaining fire safety system 6. Exempt from BCA under clause 164B, 187 or 188 7. Maintaining a building component of a system 8. Exempt under environmental planning 9. Fit out only 10. Other

proposed24HrWorkobject(ScheduleWorkDay)

This is to track the proposed hours of work when applicable.

isNaturalDisasterstring

Used to hold whether the application the direct result of a matter declared by the government to be an emergency and/or a natural disaster or not .

estimatedAreaOfAsbestosMaterialstring(decimal)non-empty

Used to Estimate of the area (if any) in square meters of bonded asbestos material or friable asbestos material that will be disturbed, repaired or removed in the carrying out of the development (m2)

estimatedCoststring(decimal)

This is to track the the estimated development cost, including GST.

lotTypestringnon-empty

It infers the lot type. One of the below mentioned values must be selected for lotType 1. Corner lot 2. Parallel road lot 3. Battle-axe lot 4. Standard lot

Example: "Refer to description for values"
haveMoreBasixboolean

This is to track if the applicant has one or more BASIX certificates when applicable.

basixCertificateNumberArray of objects(BasixCertificateNumber)
referencePlanningCertificateNumberstring

Please enter 10.7 certificate number related to this application."This is mandatory when Was the 10.7 certificate applied for via the NSW Planning Portal? is false"

certificate10.7Obtainedboolean

Have you already obtained a 10.7 certificate?

has10.7Onlinecaseboolean

This field is mandatory when "certificate10.7Obtained" this is true. Was the 10.7 certificate applied for via the NSW Planning Portal?

portalReferenceNumberstring<= 1500 characters

Please provide portal reference number. and this field is mandatory when 'has10.7Onlinecase' is true.

registeredCertifierOrgDetailsobject(registeredCertifierOrgDetails)

This indicates the organisation details of the nominated Registered certifier.

principalCertifierOrgDetailsobject(principalCertifierOrgDetails)

This indicates the organisation details of the nominated Principal certifier.

certifierOrgDetailsobject

This contains Nominated Certifier details. This is obsolete and is replaced by the relevant registeredCertifierOrgDetails & principalCertifierOrgDetails object.

isS68LGActApprovalReqboolean

Is approval under s68 of the Local Government Act 1993 required?

isS68Appliedboolean

When 'IsS68LGActApprovalReq' is true this field is mandatory. Have you already applied for approval under s68 of the Local Government Act?

applyS68Approvalboolean

Would you like to apply for approval under s68 of the Local Government Act? Applicable when -Have you already applied for approval under s68 of the Local Government Act? is "false" and address falls under same CouncilForS68

startPlanningCertificateApplicationboolean

Would you like to start a Planning Certificate 10.7 application?. Applicable when Have you already obtained a 10.7 certificate? is "false" and address falls under same council For PC107. value will be either true or false

hasOnlines68Caseboolean

When 'IsS68Applied' is true this field is mandatory. Was the s68 certificate applied for via the NSW Planning Portal?

s68ReferenceNumberstring<= 1500 characters

Please provide portal reference number. and this field is mandatory when 'HasOnlines68Case' is true.

s68RelatedRefNostring

Please enter s68 reference number related to this application. and this field is mandatory when 'HasOnlines68Case' is false.

documentsArray of objects(DownloadableDocument)

This block will be sending the full set of documents.

deltaDocumentsArray of objects(DownloadableDocument)

This block will be sending the delta documents uploaded or updated as part of update operation.

buildingPractitionerArray of objects(buildingpractitioner)

This is an obsolete attribute and will not be entered by the applicant anymore. List of Building Practitioner. Providing the details of the Registered Practitioner for certain developments will become visible in the future. This requirement will apply where all or part of the development falls within Class 2 of the Building Code of Australia.

designpractitionerArray of objects(designpractitioner)

This is an obsolete attribute and will not be entered by the applicant anymore. List of engineers. Providing the details of the Registered Practitioner for certain developments. This requirement will apply where all or part of the development falls within Class 2 of the Building Code of Australia.

principaldesignpractitionerArray of objects(principaldesignpractitioner)

This is an obsolete attribute and will not be entered by the applicant anymore. List of Designer. Providing the details of the Registered Practitioner for certain developments will become visible in the future. This requirement will apply where all or part of the development falls within Class 2 of the Building Code of Australia.

employeeDeclarationboolean

Are you an employee / Councillor or relative of an employee / Councillor within the same local government area as the proposed development?

natureOfRelationshipstring

Nature of relationship. One of the below mentioned values must be selected for natureOfRelationship 1. I am an employee 2. I am a councillor 3. I am a relative of, or relationship with, employee or Councillor

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

It will hold the date of the Building work commencement. This will be passed when the applicant performs IntentionToCommenceWork local action

isExistingCemeteryboolean

This is to track if the application is for an existing cemetery. This question is applicable and mandatory when the development type is Cemetery.

isStateHeritageRegisteredboolean

This is to track if the development to be carried out on land that is listed on the State Heritage Register under the Heritage Act 1977. This question is applicable and mandatory when the development type is Cemetery.

isSubjectToInterimHeritageOrderboolean

This is to track if the development to be carried out on land that is subject to an interim heritage order. This question is applicable and mandatory when the development type is Cemetery.

isEnvironmentalHeritageboolean

This is to track if the development to be carried out on land that is identified as an item of environmental heritage. This question is applicable and mandatory when the development type is Cemetery.

isActiveCemeteryboolean

This is to track if the application is for an active cemetery (i.e., accepting new burials). This question is applicable and mandatory when the development type is Cemetery.

declarationsArray of strings(declarations)

Declarations for CDC

Example: ["Refer to description for values"]
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/UpdateCDC/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "contributionDetails": [
      {
        "caseID": "CON-5453",
        "status": "In-progress"
      }
    ],
    "applicant": {
      "title": "Refer to description for values",
      "applicantPerson": {
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "string"
      },
      "address": "string",
      "isApplyBehalfOnCompany": true,
      "isManualEntry": true,
      "applyOnBehalfCompany": {
        "companyName": "string",
        "tradeName": "string",
        "ABN": "string",
        "ACN": "string"
      },
      "nominatedCompanyApplicant": true
    },
    "siteAddresses": [
      {
        "address": "19-33 Elizabeth Street, Narrandera, 2700",
        "addressDetail": {
          "complexUnitType": "string",
          "complexLevelType": "string",
          "complexLevelNumber": "string",
          "complexUnitIdentifier": "string",
          "streetNumber1": "string",
          "streetNumber2": "string",
          "streetName": "string",
          "streetSuffix": "string",
          "streetType": "string",
          "suburb": "string",
          "latitude": 0,
          "longitude": 0,
          "wkid": "string",
          "cadastralID": "string",
          "gurasID": "string",
          "primarySecondary": "string",
          "state": "string",
          "postCode": 0
        },
        "lotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX"
          }
        ],
        "lga": "PENRITH",
        "isPrimary": true
      }
    ],
    "relatedCases": [
      {
        "relatedCase": "string"
      }
    ],
    "ownership": "Refer to description for values",
    "typeOfBuilder": "Refer to description for values",
    "builderOrPrincipalContractorDetails": [
      {
        "builderType": "Refer to description for values",
        "builderPerson": {
          "title": "string",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string",
          "licenseNumber": "string"
        },
        "builderCompany": {
          "company": {
            "companyName": "string",
            "ABN": "string",
            "ACN": "string",
            "tradingName": "string"
          },
          "address": "string",
          "email": "string"
        }
      }
    ],
    "ownerDetails": [
      {
        "isOwnerABuilder": true,
        "title": "Refer to description for values",
        "ownerPerson": {
          "firstName": "John",
          "otherName": "Darren",
          "familyName": "Smith",
          "email": "john.smith@gmail.com",
          "contactNumber": "stringst"
        },
        "ownerCompany": {
          "companyName": "string",
          "ABN": "string"
        },
        "address": "19-33 Elizabeth Street, Narrandera, 2700"
      }
    ],
    "ownersConsentDeclaration": "string",
    "securityConditions": true,
    "detailsOfSecurityConditions": "string",
    "developerDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "emailAddress": "john.smith@gmail.com"
    },
    "payerInformation": {
      "payerType": "Refer to description for values",
      "payerPerson": {
        "title": "Refer to description for values",
        "payerInfo": {
          "firstName": "John",
          "otherName": "Darren",
          "familyName": "Smith",
          "email": "john.smith@gmail.com",
          "contactNumber": "string"
        },
        "billingAddress": "string"
      },
      "payerCompany": {
        "applicantCompany": {
          "companyName": "string",
          "ABN": "string",
          "ACN": "string",
          "tradingName": "string"
        },
        "mailingAddress": "string",
        "email": "string"
      }
    },
    "applicationType": "Refer to description for values",
    "isPatternBookApplication": true,
    "patternID": "string",
    "isDuplicatePatternID": true,
    "determinedNotified": "2020-12-02",
    "DANumber": "string",
    "proposedModificationDescription": "string",
    "hasCDCOnlinecase": true,
    "caseSubmittedDate": "2019-08-24",
    "isPoolSpa40KlitersProposed": true,
    "CDCportalReferenceNumber": "string",
    "commonApplicationTypes": [
      {
        "commonApplicationType": "string"
      }
    ],
    "subdivisionTypes": [
      "string"
    ],
    "numOfExistingLots": 0,
    "numOfProposedLots": 0,
    "developmentTypes": [
      {
        "developmentType": "Dwelling house"
      }
    ],
    "descriptionOfWork": "string",
    "isPreviousDevelopmentConsentSubmitted": true,
    "isPreviousApplicationSubmittedViaPortal": true,
    "previousDevelopmentConsentCaseID": "string",
    "isDevelopmentExemptfromDBPAct": true,
    "developmentExemptReason": "string",
    "proposed24HrWork": {
      "isMonWorkDay": true,
      "MonWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isTueWorkDay": true,
      "TueWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isWedWorkDay": true,
      "WedWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isThuWorkDay": true,
      "ThuWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isFriWorkDay": true,
      "FriWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isSatWorkDay": true,
      "SatWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      },
      "isSunWorkDay": true,
      "SunWorkDay": {
        "proposed24HrWork": true,
        "startWorkingHours": "09:30 AM",
        "endWorkingHours": "05:30 PM"
      }
    },
    "isNaturalDisaster": "string",
    "estimatedAreaOfAsbestosMaterial": "string",
    "estimatedCost": "string",
    "lotType": "Refer to description for values",
    "haveMoreBasix": true,
    "basixCertificateNumber": [
      {
        "certificateNumber": "string"
      }
    ],
    "referencePlanningCertificateNumber": "string",
    "certificate10.7Obtained": true,
    "has10.7Onlinecase": true,
    "portalReferenceNumber": "string",
    "registeredCertifierOrgDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "email": "user@example.com"
    },
    "principalCertifierOrgDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "email": "user@example.com"
    },
    "certifierOrgDetails": {
      "certifierOrgName": "string",
      "tradingName": "string",
      "ABN": "string",
      "ACN": "string",
      "certifierOrgAddress": "string"
    },
    "isS68LGActApprovalReq": true,
    "isS68Applied": true,
    "applyS68Approval": true,
    "startPlanningCertificateApplication": true,
    "hasOnlines68Case": true,
    "s68ReferenceNumber": "string",
    "s68RelatedRefNo": "string",
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "deltaDocuments": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "buildingPractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "searchBusinessBy": "Refer to description for values",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            {
              "practitionerTypeValue": "Refer to description for values."
            }
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "designpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "designPractitionerType": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "searchBusinessBy": "Refer to description for values",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            {
              "practitionerTypeValue": "Refer to description for values."
            }
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "principaldesignpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "searchBusinessBy": "Refer to description for values",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            {
              "practitionerTypeValue": "Refer to description for values."
            }
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "employeeDeclaration": true,
    "natureOfRelationship": "Refer to description for values",
    "buildingWorkCommencementDt": "2019-08-24",
    "isExistingCemetery": true,
    "isStateHeritageRegistered": true,
    "isSubjectToInterimHeritageOrder": true,
    "isEnvironmentalHeritage": true,
    "isActiveCemetery": true,
    "declarations": [
      "Refer to description for values"
    ]
  }'

Responses

Case Submitted by Applicant

Body
Response
No content

Withdraw

Request

This operation transfers the applicant's decision to withdraw the CDC application from the Online CDC Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

The council LGA name or Private Certifier Organisation name to indicate where the response is routed to.

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

caseStatusstring[ 1 .. 80 ] charactersrequired

Status of the CDC case

Example: "Submitted"
withdrawalDatestring(date)

Date on which case is withdrawn

updatedByobject(UpdatedBy)required
updatedBy.​personobject(PersonBody)
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/Withdraw/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "withdrawalDate": "2019-08-24",
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case withdrawn

Body
Response
No content

UpdateAdditionalInfo

Request

This operation transfers additional information uploaded by the applicant from the Online CDC Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

Private Certifier Organisation 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

caseStatusstringnon-emptyrequired

Status of the request for additional information

Example: "Complete"
childCaseIDstring

An AI case id for RFI

Example: "AI-XXXX"
primaryCaseIDstring

Used to hold CDC case ID.

Example: "CDC-XXXX"
responseDatestring(date)non-emptyrequired

Date and time of response

responseDetailsstring

Additional information description provided by the applicant

DocumentsArray of objects(DownloadableDocument)
updatedByobject(UpdatedBy)
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/UpdateAdditionalInfo/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Complete",
    "childCaseID": "AI-XXXX",
    "primaryCaseID": "CDC-XXXX",
    "responseDate": "2019-08-24",
    "responseDetails": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Successfully provided the information

Body
Response
No content