ONLINE CERTIFICATE REGISTRATION SERVICE APIS V1

CR - Certifier to ePlanning API (v1)

Certification Register Management API for Private Certifier

Download OpenAPI description

CR - Certifier to ePlanning API v1.0.json

CR - Certifier to ePlanning API v1.0.yaml

Overview

Servers

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

CreateCRCase

Request

This operation transfers the certificate registration application entered by the certifier from their IT system to the Online Certificate Registration Service.By performing this operation, the certifier is providing their consent to all declarations when registering the application with Council in the Certificate Registration service. For more information on the applicable declarations, please refer to the key 'consentlist' using the 'Reference Data API'.

Headers

OrganisationIDstringrequired

The Certifier name to indicate where the request is originated from

Bodyapplication/jsonrequired

body

CertificateTypestringrequired

It infers the certificate type. One of the below mentioned values must be selected for One of the below mentioned values must be selected for CertificateType. For latest values, please refer to the reference data API. 1. Complying Development Certificate (CDC) 2. Construction Certificate (CC) 3. Occupation Certificate (OC) 4. Subdivision Certificate (SC) 5. Subdivision Works Certificate (SWC) 6. Other

Example: "Refer to description for values"

EnterCertificateTypestring<= 50 characters

Required only when user selects OTHER in Certificate type

parentCaseIDstring

This indicates the parentCaseID for which the Certificate registration is requested for. It refers to the PCC certificate ID (CFT-XXXX) or the Complying development Certificate ID (CDC-XXXX). A CR case will be created and linked to this parentCaseID.

Example: "CDC-XXXXX"

registrationAuthoritystring

This indicates the registration authority to whom the CR application is routed to. Registration authority can be either councils or agencies. Council value is enabled as a default value to support existing customers. Below are the list of values 1. Council 2. Department of Planning and Environment 3. Sydney Olympic Park Authority 4. Transport for NSW 5. Lord Howe Island Board

isExistingCRboolean

This indicates if the user is applying for a modification CR or a new CR.'true' value to be used for modificiation CR. 'false' value to be used for a new CR, which is also a default value. This is applicable for CDC CRs only.

existingCRRegistrationDatestring(date)

This indicates on what date was the application to be modified registered. This is applicable for modification CDC CRs only (isExistingCR = true).

existingCRNumberstring

This indicates the existing CR application number. This is applicable for modification CDC CRs only. (isExistingCR = true).

proposedModificationstring

This indicates the description of the proposed modification. This is applicable for modification CDC CRs only (isExistingCR = true).

wasExistingCRAppliedViaNSWPortalboolean

This indicates if the CR applied for was via the NSW planning portal. This is applicable modification CDC CRs only (isExistingCR = true).

existingNSWPortalCRNumberstring

This indicates the existing CR number that's obtained through NSW planning portal. This is applicable when 'wasExistingCRAppliedViaNSWPortal' is true.

ContactDetailsobject(Contact)required

ContactDetails.Titlestring(Title)

One of the below mentioned values must be selected for Title. For latest values, please refer to the reference data API. 1. Miss 2. Mr 3. Mrs 4. Ms

Example: "Refer to description for values"

ContactDetails.ContactPersonobject(IndividualDetails)

ContactDetails.addressstring<= 250 characters

ContactDetails.companynamestring<= 50 characters

CertificateIssuedBybooleanrequired

Is the certificate was issued by the contact, same as above contact details

CertifierDetailsobject(CertifierDetails)required

CertifierDetails.Titlestring(Title)

One of the below mentioned values must be selected for Title. For latest values, please refer to the reference data API. 1. Miss 2. Mr 3. Mrs 4. Ms

Example: "Refer to description for values"

CertifierDetails.CertifierPersonobject(IndividualDetails)required

CertifierDetails.CertifierPerson.firstNamestring<= 20 charactersrequired

CertifierDetails.CertifierPerson.otherGivenNamestring<= 20 characters

CertifierDetails.CertifierPerson.familyNamestring<= 20 charactersrequired

CertifierDetails.CertifierPerson.contactNumberstring[ 8 .. 10 ] characters^[0-9]+$

CertifierDetails.CertifierPerson.emailstring(email)<= 250 charactersrequired

CertifierDetails.addressstring<= 250 charactersrequired

CertifierDetails.accreditationNumberstring<= 50 charactersrequired

BPB accreditation number

CertifierDetails.companyNamestring<= 250 characters

CertificateDetailsobject(CertificateInformation)required

CertificateDetails.ApplicationDatestring(date)

Displayed if 'Was certificate issued? ' = yes,Must only be a past or current date. Cannot be a future date.

CertificateDetails.CertifierReferenceNumberstring<= 50 charactersrequired

CertificateDetails.DANumberstring<= 20 charactersrequired

Display only if user selected 'Yes' for Has the DA been determined? and only applicable when CertificateType is Construction Certificate (CC) (OR) Occupation Certificate (OC) (OR) Subdivision Certificate (SC) (OR) Subdivision Works Certificate (SWC)

CertificateDetails.DateOfDeterminationstring(date)

Display only if user selected 'Yes' for Has the DA been determined?Can be current or past date, cannot be a future date and only applicable when CertificateType is - Construction Certificate (CC) (OR) Occupation Certificate (OC) (OR) Subdivision Certificate (SC) (OR) Subdivision Works Certificate (SWC)

CertificateDetails.DateOfIssuestring(date)

Displayed if 'Was certificate issued? ' = yes,Must only be a past or current date. Cannot be a future date.

CertificateDetails.DateOfNotificationstring(date)

Displayed if 'Was certificate issued?' = yes,Can be past or current date but must not be future date.

CertificateDetails.DateofWorkCommencementstring(date)

Displayed if 'Was certificate issued? ' = yes,Display only for CDC, OC and CC and SWC certificate types,This can be past, current or future date.

CertificateDetails.IsDADeterminedbooleanrequired

Available options are Yes/No selection and only applicable when CertificateType is - Construction Certificate (CC) (OR) Occupation Certificate (OC) (OR) Subdivision Certificate (SC) (OR) Subdivision Works Certificate (SWC)

CertificateDetails.IsDevelopmentTypeResidentialbooleanrequired

CertificateDetails.certificateIssuedbooleanrequired

Available options are Yes/No selection

CertificateDetails.PrincipalCertifyingAuthoritystring<= 50 characters

CertificateDetails.IsCDCDeterminedbooleanrequired

Available options are Yes/No selection and only applicable when CertificateType is - Occupation Certificate (OC) (OR) Subdivision Certificate (SC) (OR) Subdivision Works Certificate (SWC)

CertificateDetails.CDCNumberstring<= 40 charactersrequired

Display only if user selected 'Yes' for Has the CDC been determined? and only applicable when CertificateType is - Occupation Certificate (OC) (OR) Subdivision Certificate (SC) (OR) Subdivision Works Certificate (SWC)

CertificateDetails.DateOfCDCDeterminationstring(date)

Display only if user selected 'Yes' for Has the CDC been determined?Can be current or past date, cannot be a future date and only applicable when CertificateType is - Occupation Certificate (OC) (OR) Subdivision Certificate (SC) (OR) Subdivision Works Certificate (SWC)

ApplicantDetailsobject

BuilderListArray of objects(Builder)

This is to track the Builder List. This field is not required for 'Subdivision Certificate (SC)' and 'Other' certificate types. And it is mandatory for Occupation Certificate (OC) while optional for Complying Development Certificate (CDC),Construction Certificate (CC),Subdivision Works Certificate (SWC).

addressDidNotDisplayboolean

The respective attribute to be selcted as true if user wants to provide address manually and by not using spatial viewer.

siteAddressesArray of objects(Location)

DevelopmentApplicationobject

commonApplicationTypesArray of objects(CommonApplicationType)

This is to track the common Application types. This is applicable for CR-CC, CR-OC, CR-PCA and is required for it's corresponding parent cases that are created after 1st of September'23. 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

subdivisionTypesArray of strings

This is to track the appropriate subdivision types. This is applicable when 'Subdivision' is one of the common application type('commonApplicationTypes'). This is not applicable for CR-CC & CR-OC. 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 type('commonApplicationTypes'). This is not applicable for CR-CC & CR-OC.

numOfProposedLotsinteger

This is to track the number of proposed lots. This is applicable when 'Subdivision' is one of the common application type('commonApplicationTypes').This is not applicable for CR-CC & CR-OC.

DevelopmentTypeArray of objects(CRDevelopmentType)

developmentPurposestring<= 20 characters

required only if 'OTHER' is selected for development type

isDevAffectingExistingBuildingboolean

It infers that is Existing building affected by the development or not. If the value is Yes then Record of inspection document type is mandatory document to be provided. isDevAffectingExistingBuilding is mandatory field for Construction Certificate only.

ConsentListArray of objects(consentList)required

ConsentList[].consentstringrequired

By performing this operation, the certifier is providing their consent to all declarations when registering the application with Council in the Certificate Registration service. Note: The NSW Planning Portal will not be comparing the text received for each declaration. For more information on the applicable declarations, please refer to the key 'consentlist' using the 'Reference Data API'. Below are the example declaration values. 1. I have read and agree to the collection and use of my personal information as outlined in the Privacy Notice. 2. I understand that if incomplete, the Council may request more information. 3. I understand that a payment needs to be made for the registration to be submitted to the Council. 4. I agree to pay any required NSW Planning Portal Service Fee/s specified under Clause 263B of the Environmental Planning and Assessment Regulation 2000 to the Department of Planning, Housing and Infrastructure.

Example: "Refer to description for values"

DocumentsArray of objects(DownloadableDocument)

createdByEmailstring<= 250 characters

This indicates the email address of the user submitting CR. User must be registered in the planning portal and would belong to the relevant organisation.

Example: "john.smith@gmail.com"

curl -i -X POST \
  https://api-uat.apps1.nsw.gov.au/planning/CRMgmt/PrivateCertifiers/v1/CreateCRCase/ \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "CertificateType": "Refer to description for values",
    "EnterCertificateType": "string",
    "parentCaseID": "CDC-XXXXX",
    "registrationAuthority": "string",
    "isExistingCR": true,
    "existingCRRegistrationDate": "2019-08-24",
    "existingCRNumber": "string",
    "proposedModification": "string",
    "wasExistingCRAppliedViaNSWPortal": true,
    "existingNSWPortalCRNumber": "string",
    "ContactDetails": {
      "Title": "Refer to description for values",
      "ContactPerson": {
        "firstName": "string",
        "otherGivenName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com"
      },
      "address": "string",
      "companyname": "string"
    },
    "CertificateIssuedBy": true,
    "CertifierDetails": {
      "Title": "Refer to description for values",
      "CertifierPerson": {
        "firstName": "string",
        "otherGivenName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com"
      },
      "address": "string",
      "accreditationNumber": "string",
      "companyName": "string"
    },
    "CertificateDetails": {
      "ApplicationDate": "2019-08-24",
      "CertifierReferenceNumber": "string",
      "DANumber": "string",
      "DateOfDetermination": "2019-08-24",
      "DateOfIssue": "2019-08-24",
      "DateOfNotification": "2019-08-24",
      "DateofWorkCommencement": "2019-08-24",
      "IsDADetermined": true,
      "IsDevelopmentTypeResidential": true,
      "certificateIssued": true,
      "PrincipalCertifyingAuthority": "string",
      "IsCDCDetermined": true,
      "CDCNumber": "string",
      "DateOfCDCDetermination": "2019-08-24"
    },
    "ApplicantDetails": {
      "name": "string",
      "address": "string",
      "companyName": "string"
    },
    "BuilderList": [
      {
        "Title": "Refer to description for values",
        "builderPerson": {
          "firstName": "string",
          "otherGivenName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com"
        },
        "address": "string",
        "licensenumber": "string",
        "insurerDetail": [
          {
            "InsurerLicenseNumber": "string",
            "RegisteredBusinessName": "string"
          }
        ]
      }
    ],
    "addressDidNotDisplay": true,
    "siteAddresses": [
      {
        "address": "19-33 Elizabeth Street, Narrandera, 2700",
        "gurasID": 2636480,
        "lga": "BLACKTOWN",
        "LotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX",
            "lotNumber": "333",
            "planNumber": "111",
            "sectionNumber": "222"
          }
        ],
        "isPrimary": true
      }
    ],
    "DevelopmentApplication": {
      "CostOfDevelopment": "string",
      "developmentDescription": "string"
    },
    "commonApplicationTypes": [
      {
        "commonApplicationType": "string"
      }
    ],
    "subdivisionTypes": [
      "string"
    ],
    "numOfExistingLots": 0,
    "numOfProposedLots": 0,
    "DevelopmentType": [
      {
        "typeOfDevelopment": "string"
      }
    ],
    "developmentPurpose": "string",
    "isDevAffectingExistingBuilding": true,
    "ConsentList": [
      {
        "consent": "Refer to description for values"
      }
    ],
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "http://example.com"
      }
    ],
    "createdByEmail": "john.smith@gmail.com"
  }'

Responses

CR-xxxx-xxxx Case has been created successfully.

Bodyapplication/json

statusCodeinteger

Example: 200

messagestring

Example: "CR-XXXX-XXXX Case has been created successfully"

activityIdstring

caseIDstring

Example: "CR-XXXX-XXXX"

DocumentsArray of objects(DocResponse)

Attached documents with eplanningDocIds.

Response

application/json

{
  "statusCode": 200,
  "message": "CR-XXXX-XXXX Case has been created successfully",
  "activityId": "string",
  "caseID": "CR-XXXX-XXXX",
  "Documents": [
    { … }
  ]
}

OnlineCRCaseDetails

Request

This operation enables the relevant organisation to request ePlanning to send the list of case ids, submitted date, Certifiers Certificate Reference Number, DA Number, CDC number, Accreditation No and certificate type in to their IT system.

Headers

OrganisationIDstring

The relevant organisation name to indicate where the request is originated from.

accreditationNumberstring

This refers to the the Registration Number of the certifier.

certifiersCertificateReferenceNumberstringrequired

This refers to the certifiers Certificate reference number. This is enabled with partial match search using the 'contains' condition. The minimum character length is set to 5.

DANumberstring

This refers to the DAnumber that is related to the certificate.

CDCNumberstring

This refers to the CDCnumber that is related to the certificate.

caseCreatedStartDatestring(date)

This refers to the timelines of the case creation date. Timeline searches can be acheived through this attribute. Date format is "yyyy-MM-dd".

caseCreatedEndDatestring(date)

This refers to the timelines of the case creation date. Timeline searches can be acheived through this attribute. Date format is "yyyy-MM-dd".

certificateTypestringrequired

This refers to the type of certificate for which the case has been created.

curl -i -X GET \
  https://api-uat.apps1.nsw.gov.au/planning/CRMgmt/PrivateCertifiers/v1/OnlineCRCaseDetails/ \
  -H 'CDCNumber: string' \
  -H 'DANumber: string' \
  -H 'OrganisationID: string' \
  -H 'accreditationNumber: string' \
  -H 'caseCreatedEndDate: 2019-08-24' \
  -H 'caseCreatedStartDate: 2019-08-24' \
  -H 'certificateType: string' \
  -H 'certifiersCertificateReferenceNumber: string'

Responses

Case updated

Bodyapplication/jsonArray [

caseIDstringrequired

This refers to the caseID of the case.

submittedDatestring(date)required

This refers to the date on which the case was submitted.

certifiersCertificateReferenceNumberstring

This refers to the certifiers Certificate reference number.

DANumberstring

This refers to the DAnumber that is related to the certificate

CDCNumberstring

This refers to the CDCnumber that is related to the certificate.

accreditationNumberstring

This refers to the the Registration Number of the certifier.

certificateTypestring

This refers to the type of certificate for which the case of created.

dateOfIssuestring

This refers to the Certificate's date of issue.

]

Response

application/json

[
  {
    "caseID": "string",
    "submittedDate": "2019-08-24",
    "certifiersCertificateReferenceNumber": "string",
    "DANumber": "string",
    "CDCNumber": "string",
    "accreditationNumber": "string",
    "certificateType": "string",
    "dateOfIssue": "string"
  }
]

UpdateCRCase

Request

This operation updates the certificate registration application entered by the certifier from their IT system to the Online Certificate Registration Service.By performing this operation, the certifier is providing their consent to all declarations when registering the application with Council in the Certificate Registration service. For more information on the applicable declarations, please refer to the key 'consentlist' using the 'Reference Data API'.

Path

CaseIDstringrequired

A fully qualified application number or case id

Headers

OrganisationIDstringrequired

The Certifier name to indicate where the request is originated from

Bodyapplication/json

body

CertificateTypestringrequired

Example: "Refer to description for values"

EnterCertificateTypestring<= 50 characters

Required only when user selects OTHER in Certificate type

isExistingCRboolean

This�indicates�if�the�user�is�applying�for�a�modification�CR�or�a�new�CR.�'true'�value�to�be�used�for�modificiation�CR. 'false'�value�to�be�used�for�a�new�CR, which is also a default value.�This�is�applicable�for�CDC�CRs�only.�

existingCRRegistrationDatestring(date)

This indicates on what date was the application to be modified registered. This is applicable for modification CDC CRs only (isExistingCR = true).

existingCRNumberstring

This indicates the existing CR application number. This is applicable for modification CDC CRs only. (isExistingCR = true).

proposedModificationstring

This indicates the description of the proposed modification. This is applicable for modification CDC CRs only (isExistingCR = true).

wasExistingCRAppliedViaNSWPortalboolean

This indicates if the CR applied for was via the NSW planning portal. This is applicable modification CDC CRs only (isExistingCR = true).

existingNSWPortalCRNumberstring

This indicates the existing CR number that's obtained through NSW planning portal. This is applicable when 'wasExistingCRAppliedViaNSWPortal' is true.

registrationAuthoritystring

ContactDetailsobject(Contact)required

ContactDetails.Titlestring(Title)

One of the below mentioned values must be selected for Title. For latest values, please refer to the reference data API. 1. Miss 2. Mr 3. Mrs 4. Ms

Example: "Refer to description for values"

ContactDetails.ContactPersonobject(IndividualDetails)

ContactDetails.addressstring<= 250 characters

ContactDetails.companynamestring<= 50 characters

CertificateIssuedBybooleanrequired

Is the certificate was issued by the contact, same as above contact details

CertifierDetailsobject(CertifierDetails)required

CertifierDetails.Titlestring(Title)

One of the below mentioned values must be selected for Title. For latest values, please refer to the reference data API. 1. Miss 2. Mr 3. Mrs 4. Ms

Example: "Refer to description for values"

CertifierDetails.CertifierPersonobject(IndividualDetails)required

CertifierDetails.CertifierPerson.firstNamestring<= 20 charactersrequired

CertifierDetails.CertifierPerson.otherGivenNamestring<= 20 characters

CertifierDetails.CertifierPerson.familyNamestring<= 20 charactersrequired

CertifierDetails.CertifierPerson.contactNumberstring[ 8 .. 10 ] characters^[0-9]+$

CertifierDetails.CertifierPerson.emailstring(email)<= 250 charactersrequired

CertifierDetails.addressstring<= 250 charactersrequired

CertifierDetails.accreditationNumberstring<= 50 charactersrequired

BPB accreditation number

CertifierDetails.companyNamestring<= 250 characters

CertificateDetailsobject(CertificateInformation)required

CertificateDetails.ApplicationDatestring(date)

Displayed if 'Was certificate issued? ' = yes,Must only be a past or current date. Cannot be a future date.

CertificateDetails.CertifierReferenceNumberstring<= 50 charactersrequired

CertificateDetails.DANumberstring<= 20 charactersrequired

CertificateDetails.DateOfDeterminationstring(date)

CertificateDetails.DateOfIssuestring(date)

Displayed if 'Was certificate issued? ' = yes,Must only be a past or current date. Cannot be a future date.

CertificateDetails.DateOfNotificationstring(date)

Displayed if 'Was certificate issued?' = yes,Can be past or current date but must not be future date.

CertificateDetails.DateofWorkCommencementstring(date)

Displayed if 'Was certificate issued? ' = yes,Display only for CDC, OC and CC and SWC certificate types,This can be past, current or future date.

CertificateDetails.IsDADeterminedbooleanrequired

CertificateDetails.IsDevelopmentTypeResidentialbooleanrequired

CertificateDetails.certificateIssuedbooleanrequired

Available options are Yes/No selection

CertificateDetails.PrincipalCertifyingAuthoritystring<= 50 characters

CertificateDetails.IsCDCDeterminedbooleanrequired

Available options are Yes/No selection and only applicable when CertificateType is - Occupation Certificate (OC) (OR) Subdivision Certificate (SC) (OR) Subdivision Works Certificate (SWC)

CertificateDetails.CDCNumberstring<= 40 charactersrequired

CertificateDetails.DateOfCDCDeterminationstring(date)

ApplicantDetailsobject

BuilderListArray of objects(Builder)

addressDidNotDisplayboolean

The respective attribute to be selcted as true if user wants to provide address manually and by not using spatial viewer.

siteAddressesArray of objects(Location)

DevelopmentApplicationobject

commonApplicationTypesArray of objects(CommonApplicationType)

This is to track the common Application types.This is applicable for CR-CC, CR-OC, CR-PCA and is required for it's corresponding parent cases that are created after 1st of September'23. 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

subdivisionTypesArray of strings

This is to track the appropriate subdivision types. This is applicable when 'Subdivision' is one of the common application type('commonApplicationTypes').This is not applicable for CR-CC & CR-OC. 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 type('commonApplicationTypes').This is not applicable for CR-CC & CR-OC.

numOfProposedLotsinteger

This is to track the number of proposed lots. This is applicable when 'Subdivision' is one of the common application type('commonApplicationTypes').This is not applicable for CR-CC & CR-OC.

DevelopmentTypeArray of objects(CRDevelopmentType)

developmentPurposestring<= 20 characters

required only if 'OTHER' is selected for development type

isDevAffectingExistingBuildingboolean

ConsentListArray of objects(consentList)required

ConsentList[].consentstringrequired

Example: "Refer to description for values"

DocumentsArray of objects(DownloadableDocument)

updatedByEmailstring<= 250 characters

This indicates the email address of the user updating CR. User must be registered in the planning portal and would belong to the relevant organisation.

Example: "john.smith@gmail.com"

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/CRMgmt/PrivateCertifiers/v1/UpdateCRCase/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "CertificateType": "Refer to description for values",
    "EnterCertificateType": "string",
    "isExistingCR": true,
    "existingCRRegistrationDate": "2019-08-24",
    "existingCRNumber": "string",
    "proposedModification": "string",
    "wasExistingCRAppliedViaNSWPortal": true,
    "existingNSWPortalCRNumber": "string",
    "registrationAuthority": "string",
    "ContactDetails": {
      "Title": "Refer to description for values",
      "ContactPerson": {
        "firstName": "string",
        "otherGivenName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com"
      },
      "address": "string",
      "companyname": "string"
    },
    "CertificateIssuedBy": true,
    "CertifierDetails": {
      "Title": "Refer to description for values",
      "CertifierPerson": {
        "firstName": "string",
        "otherGivenName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com"
      },
      "address": "string",
      "accreditationNumber": "string",
      "companyName": "string"
    },
    "CertificateDetails": {
      "ApplicationDate": "2019-08-24",
      "CertifierReferenceNumber": "string",
      "DANumber": "string",
      "DateOfDetermination": "2019-08-24",
      "DateOfIssue": "2019-08-24",
      "DateOfNotification": "2019-08-24",
      "DateofWorkCommencement": "2019-08-24",
      "IsDADetermined": true,
      "IsDevelopmentTypeResidential": true,
      "certificateIssued": true,
      "PrincipalCertifyingAuthority": "string",
      "IsCDCDetermined": true,
      "CDCNumber": "string",
      "DateOfCDCDetermination": "2019-08-24"
    },
    "ApplicantDetails": {
      "name": "string",
      "address": "string",
      "companyName": "string"
    },
    "BuilderList": [
      {
        "Title": "Refer to description for values",
        "builderPerson": {
          "firstName": "string",
          "otherGivenName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com"
        },
        "address": "string",
        "licensenumber": "string",
        "insurerDetail": [
          {
            "InsurerLicenseNumber": "string",
            "RegisteredBusinessName": "string"
          }
        ]
      }
    ],
    "addressDidNotDisplay": true,
    "siteAddresses": [
      {
        "address": "19-33 Elizabeth Street, Narrandera, 2700",
        "gurasID": 2636480,
        "lga": "BLACKTOWN",
        "LotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX",
            "lotNumber": "333",
            "planNumber": "111",
            "sectionNumber": "222"
          }
        ],
        "isPrimary": true
      }
    ],
    "DevelopmentApplication": {
      "CostOfDevelopment": "string",
      "developmentDescription": "string"
    },
    "commonApplicationTypes": [
      {
        "commonApplicationType": "string"
      }
    ],
    "subdivisionTypes": [
      "string"
    ],
    "numOfExistingLots": 0,
    "numOfProposedLots": 0,
    "DevelopmentType": [
      {
        "typeOfDevelopment": "string"
      }
    ],
    "developmentPurpose": "string",
    "isDevAffectingExistingBuilding": true,
    "ConsentList": [
      {
        "consent": "Refer to description for values"
      }
    ],
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "http://example.com"
      }
    ],
    "updatedByEmail": "john.smith@gmail.com"
  }'

Responses

Case Updated.

Bodyapplication/json

statusCodeinteger

Example: 200

messagestring

Example: "CR-XXXX-XXXX Case has been created successfully"

activityIdstring

caseIDstring

Example: "CR-XXXX-XXXX"

DocumentsArray of objects(DocResponse)

Attached documents with eplanningDocIds.

Response

application/json

{
  "statusCode": 200,
  "message": "CR-XXXX-XXXX Case has been created successfully",
  "activityId": "string",
  "caseID": "CR-XXXX-XXXX",
  "Documents": [
    { … }
  ]
}

CR - Certifier to ePlanning API (v1)

CreateCRCase

Request

Responses

Was this helpful?

OnlineCRCaseDetails

Request

Responses

Was this helpful?

UpdateCRCase

Request

Responses

Was this helpful?

CR - Certifier to ePlanning API (v1)

CreateCRCase

RequestExpand all

Responses

Was this helpful?

OnlineCRCaseDetails

Request

Responses

Was this helpful?

UpdateCRCase

RequestExpand all

Responses

Was this helpful?

Request

Request