CreateCRCase

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'.

header Parameters
OrganisationID
required
string

The Certifier name to indicate where the request is originated from

Request Body schema: application/json

body

CertificateType
required
string

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

EnterCertificateType
string <= 50 characters

Required only when user selects OTHER in Certificate type

parentCaseID
string

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.

registrationAuthority
string

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

isExistingCR
boolean

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.

existingCRRegistrationDate
string <date>

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

existingCRNumber
string

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

proposedModification
string

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

wasExistingCRAppliedViaNSWPortal
boolean

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

existingNSWPortalCRNumber
string

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

required
object (Contact)
CertificateIssuedBy
required
boolean

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

required
object (CertifierDetails)
required
object (CertificateInformation)
object
Array 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).

addressDidNotDisplay
boolean

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

Array of objects (Location)
object
Array 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

subdivisionTypes
Array 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

numOfExistingLots
integer

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.

numOfProposedLots
integer

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.

Array of objects (CRDevelopmentType)
developmentPurpose
string <= 20 characters

required only if 'OTHER' is selected for development type

isDevAffectingExistingBuilding
boolean

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.

required
Array of objects (consentList)
Array of objects (DownloadableDocument)
createdByEmail
string <= 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.

Responses

Request samples

Content type
application/json
{
  • "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": {
    },
  • "CertificateIssuedBy": true,
  • "CertifierDetails": {
    },
  • "CertificateDetails": {
    },
  • "ApplicantDetails": {
    },
  • "BuilderList": [
    ],
  • "addressDidNotDisplay": true,
  • "siteAddresses": [
    ],
  • "DevelopmentApplication": {
    },
  • "commonApplicationTypes": [
    ],
  • "subdivisionTypes": [
    ],
  • "numOfExistingLots": 0,
  • "numOfProposedLots": 0,
  • "DevelopmentType": [
    ],
  • "developmentPurpose": "string",
  • "isDevAffectingExistingBuilding": true,
  • "ConsentList": [
    ],
  • "Documents": [
    ],
  • "createdByEmail": "john.smith@gmail.com"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "CR-XXXX-XXXX Case has been created successfully",
  • "activityId": "string",
  • "caseID": "CR-XXXX-XXXX",
  • "Documents": [
    ]
}