ONLINE Concurrence and Referral SERVICE APIs V1

Concurrence and Referral ePlanning to Agency API

CNRUploadSubmission

Concurrence and Referral - ePlanning to Agency API (v1)

Authentication

Please use the subscription key provided by the Department to access the APIs.

Download OpenAPI description

CNR - ePlanning to Agency API v1.0.json

CNR - ePlanning to Agency API v1.0.yaml

Overview

Servers

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

CreateCNR

Request

This operation transfers the Council's decision to create the Concurrence and Referral case from ePlanning's IT system to the agency's Online Concurrence and Referral Service. In this operation respective agency cases are created based on clauses present in CNR case .

Path

CaseIDstringrequired

A fully qualified Concurrence and Referral case number

Headers

OrganisationIDstringrequired

The council LGA 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

caseStatusstring<= 32 characters

Status of the CNR case.

applicationTypestring(applicationTypes)required

This indicates the kind of application such as Development application, Modification application, Review of determination. One of the below mentioned values must be selected for applicationTypes 1. Development application 2. Modification application 3. Review of determination

Example: "Refer to description for values"

DALodgementDatestring(date)non-emptyrequired

Date when the original DA was lodged.

Example: "2020-18-12"

existingDANumberstring[ 1 .. 50 ] charactersrequired

holds the DA number related to the application.

securityConditionsbooleanrequired

Used to hold the value of whether are they any security or site conditions which may impact on the person undertaking the inspection.

detailsOfSecurityConditionsstring<= 512 characters

Applicable only when we select 'SecurityConditions' is true and holds the detailed description of securityConditions.

originalDADeterminationDatestring(date)

Date when the original DA was determined and is applicable when 'applicationType' is 'Modification application' or 'Review of determination'. When 'applicationType' is 'Review of determination' and 'isExistingOnlineDA' is true, then this field is not applicable.

Example: "2020-18-12"

modificationTypestring(modificationTypes)

Required if when 'applicationType' is 'Modification application'. One of the below mentioned values must be selected for modificationTypes 1. S4.55(1) - Modification to correct a minor error, misdescription or miscalculation made in the consent 2. S4.55(1A) - Modification involving minimal environmental impact, where the development will remain substantially the same as the development that was originally approved 3. S4.55(2) - Other modification, where the development will remain substantially the same as the development that was originally approved 4. S4.56 - Modification to a development consent granted by the NSW Land and Environment Court, where the development will remain substantially the same as the development that was originally approved

Example: "Refer to description for values"

proposedModificationDescriptionstring<= 512 characters

Required if when 'applicationType' is 'Modification application'

subjectOfReviewstring(SubjectOfReview)

It infers that What type of decision is subject of this review of determination?. One of the below mentioned values must be selected for SubjectOfReview 1. Determination of a Development Application 2. Determination of a Modification Application

Example: "Refer to description for values"

isExistingOnlineDAboolean

Applicable when 'applicationType' is 'Modification application' or 'Review of determination' and this checks whether the DA applied for via the NSW Planning Portal or not

stateAgencyNamestring

This is to track the corresponding stateagency names for which the referrals are created.

existingOnlinePANNumberstring<= 10 characters

This is to record the provide portal application number (DA Number) applied over NSW Planning Portal.

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

developmentTypeArray of strings(developmentTypes)

otherDevTypestring<= 100 characters

Required when 'Other' is selected in 'developmentType'

proposedDevelopmentTypeDescriptionstring[ 1 .. 512 ] charactersrequired

Required if when 'applicationType' is 'Development application' or 'Modification application'

isNaturalDisasterboolean

Is this application the direct result of a matter declared by the government to be an emergency and/or a natural disaster (for example, an application for re-building a home destroyed by bushfire)

siteAddressesArray of objects(Location)required

siteAddresses[].addressstring[ 1 .. 250 ] charactersrequired

Address where the development is happening

Example: "19-33 Elizabeth Street, Narrandera, 2700"

siteAddresses[].isPrimaryboolean

It differentiates the secondary addresses

siteAddresses[].addressDetailobject(AddressDetail)

siteAddresses[].lotListArray of objects(LotSectionPlan)

isApplyBehalfOnCompanybooleanrequired

Is the user applying on behalf of a company

companyNamestring<= 256 characters

Infers the name of the company. This is required if 'Is the application on behalf of a company, business or body corporate?' = Yes

ABNorACNstring<= 14 characters

Holds the ABN or ACN relating to the company. Lengths allowed are '11' for ABN and '9' for ACN. This is applicable if 'isApplyBehalfOnCompany' = true

applicantobject(Person)required

applicant.firstNamestring[ 1 .. 20 ] charactersrequired

applicant.familyNamestring[ 1 .. 20 ] charactersrequired

applicant.addressstring

applicant.contactNumberstring[ 8 .. 10 ] characters^[0-9]+$required

applicant.emailstring(email)[ 1 .. 250 ] charactersrequired

Example: "abc@yopmail.com"

councilNamestring

This is to track the council names for which the referrals are created.

officerResponsiblestringnon-emptyrequired

This infers the responsible officer in charge for the application

officerNumberstring

This infers the contact number of responsible officer in charge for the application.

officerEmailstring

This infers the email of responsible officer in charge for the application.

costOfDevelopmentnumber(decimal)required

Estimated cost of development

determinedAuthoritystring

It infers Which determining authority is expected to determine the application? One of the below mentioned values must be selected for determinedAuthority 1. Council 2. Sydney or Regional Planning Panel 3. Local Planning Panel 4. Central Sydney Planning Committee

Example: "Refer to description for values"

panelHearingDatestring(date)

Infers the date (which is not past) on which the Planning panel hearing will be conducted by the anticipated council. This is applicable only when 'determinedAuthority' is 'Sydney or Regional Planning Panel' or 'Local Planning Panel'

Example: "2020-18-12"

isApplicationNotifiedbooleanrequired

Is this case notified or advertised if we select isApplicationExhibited as Yes New Exhibition case will be created.

publicSubmissionEndDatestring(date)

It infers the date by which offline submission need to be received from council. By default, this is 21 days ahead of current date.

Example: "2020-18-12"

agencySelectionArray of objects(agencyAndClause)required

Infers the agency selection and it's relevant details.

agencySelection[].agencyNamestring

Name of the agency

agencySelection[].agencyOfficerEmailstring

This is to track the email of the agency officer.

agencySelection[].agencyCaseIDstring

A fully qualified agency case number.

Example: "A-XXXX"

agencySelection[].agencyCaseStatusstring

Status of the agency case.

agencySelection[].clausesArray of objects(clauseList)

The clause applicable for the corresponding agency.

agencySelection[].commentsForAgencystring<= 512 characters

Infers to comments or notes a council user would like to add for the Agency.

dateSubmittedToAgencystring(date)

The date on which agency case is submitted to agency.

Example: "2020-18-12"

documentsArray of objects(DownloadableDocument)required

documents[].documentNamestring[ 1 .. 150 ] charactersrequired

documentName has to be appended with file extension

Example: "test.docx"

documents[].documentTypestring[ 1 .. 100 ] charactersrequired

documents[].uploadedDateTimestring(date-time)non-emptyrequired

documents[].documentURLstring[ 1 .. 500 ] charactersrequired

URL of the document to be downloaded

documents[].documentSizenumber

This indicates the file size of the document in bytes

documents[].isSensitiveDocboolean

set this flag if you want to mark the document as sensitive

documents[].updatedBystring

Example: "Council"

declarationsArray of strings(CNRdeclarations)required

Example: ["Refer to description for values"]

updatedByobject(UpdatedBy)required

updatedBy.personobject(PersonBody)

curl -i -X POST \
  'https://api-uat.apps1.nsw.gov.au/planning/CreateCNR/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "string",
    "applicationType": "Refer to description for values",
    "DALodgementDate": "2020-18-12",
    "existingDANumber": "string",
    "securityConditions": true,
    "detailsOfSecurityConditions": "string",
    "originalDADeterminationDate": "2020-18-12",
    "modificationType": "Refer to description for values",
    "proposedModificationDescription": "string",
    "subjectOfReview": "Refer to description for values",
    "isExistingOnlineDA": true,
    "stateAgencyName": "string",
    "existingOnlinePANNumber": "string",
    "commonApplicationTypes": [
      {
        "commonApplicationType": "string"
      }
    ],
    "subdivisionTypes": [
      "string"
    ],
    "numOfExistingLots": 0,
    "numOfProposedLots": 0,
    "developmentType": [
      "string"
    ],
    "otherDevType": "string",
    "proposedDevelopmentTypeDescription": "string",
    "isNaturalDisaster": true,
    "siteAddresses": [
      {
        "address": "19-33 Elizabeth Street, Narrandera, 2700",
        "isPrimary": true,
        "addressDetail": {
          "complexUnitType": "string",
          "complexLevelType": "string",
          "complexLevelNumber": "string",
          "complexUnitIdentifier": "string",
          "streetNumber1": "string",
          "streetNumber2": "string",
          "streetName": "string",
          "streetSuffix": "string",
          "streetType": "string",
          "suburb": "string",
          "latitude": 0,
          "gurasID": "string",
          "longitude": 0,
          "wkid": "string",
          "cadastralID": "string",
          "primarySecondary": "string",
          "state": "string",
          "postCode": 0
        },
        "lotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX"
          }
        ]
      }
    ],
    "isApplyBehalfOnCompany": true,
    "companyName": "string",
    "ABNorACN": "string",
    "applicant": {
      "firstName": "string",
      "familyName": "string",
      "address": "string",
      "contactNumber": "stringst",
      "email": "abc@yopmail.com"
    },
    "councilName": "string",
    "officerResponsible": "string",
    "officerNumber": "string",
    "officerEmail": "string",
    "costOfDevelopment": 0,
    "determinedAuthority": "Refer to description for values",
    "panelHearingDate": "2020-18-12",
    "isApplicationNotified": true,
    "publicSubmissionEndDate": "2020-18-12",
    "agencySelection": [
      {
        "agencyName": "string",
        "agencyOfficerEmail": "string",
        "agencyCaseID": "A-XXXX",
        "agencyCaseStatus": "string",
        "clauses": [
          {
            "clauseName": "string",
            "otherClauseDescription": "string",
            "clauseType": "Refer to description for values",
            "BAMAssessment": "string",
            "reductionOfBiodiversityCredits": true
          }
        ],
        "commentsForAgency": "string"
      }
    ],
    "dateSubmittedToAgency": "2020-18-12",
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "declarations": [
      "Refer to description for values"
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case updated

Body

Response

No content

UpdateCNR

Request

This operation transfers the Council's decision to edit the Concurrence and Referral case from ePlanning's IT system to the Agency's online Concurrence and Referral Service. In this operation,council can edit CNR application details, add new agency or modify existing clause of an agency.

Path

CaseIDstringrequired

A fully qualified Concurrence and Referral application number

Headers

OrganisationIDstringrequired

The council name to indicate where the request is originated from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 32 characters

Status of the CNR case.

applicationTypestring(applicationTypes)required

Example: "Refer to description for values"

DALodgementDatestring(date)non-emptyrequired

Date when the original DA was lodged.

Example: "2020-18-12"

existingDANumberstring[ 1 .. 50 ] charactersrequired

holds the DA number related to the application.

securityConditionsbooleanrequired

Used to hold the value of whether are they any security or site conditions which may impact on the person undertaking the inspection.

detailsOfSecurityConditionsstring<= 512 characters

Applicable only when we select 'SecurityConditions' is true and holds the detailed description of securityConditions.

originalDADeterminationDatestring(date)

Example: "2020-18-12"

modificationTypestring(modificationTypes)

Example: "Refer to description for values"

proposedModificationDescriptionstring<= 512 characters

Required if when 'applicationType' is 'Modification application'

subjectOfReviewstring(SubjectOfReview)

Example: "Refer to description for values"

isExistingOnlineDAboolean

Applicable when 'applicationType' is 'Modification application' or 'Review of determination' and this checks whether the DA applied for via the NSW Planning Portal or not

stateAgencyNamestring

This is to track the corresponding stateagency names for which the referrals are created.

existingOnlinePANNumberstring<= 10 characters

This is to record the provide portal application number (DA Number) applied over NSW Planning Portal.

commonApplicationTypesArray of objects(CommonApplicationType)required

commonApplicationTypes[].commonApplicationTypestring

subdivisionTypesArray of strings

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

developmentTypeArray of strings(developmentTypes)

otherDevTypestring<= 100 characters

Required when 'Other' is selected in 'developmentType'

proposedDevelopmentTypeDescriptionstring[ 1 .. 512 ] charactersrequired

Required if when 'applicationType' is 'Development application' or 'Modification application'

isNaturalDisasterboolean

Is this application the direct result of a matter declared by the government to be an emergency and/or a natural disaster (for example, an application for re-building a home destroyed by bushfire)

siteAddressesArray of objects(Location)required

siteAddresses[].addressstring[ 1 .. 250 ] charactersrequired

Address where the development is happening

Example: "19-33 Elizabeth Street, Narrandera, 2700"

siteAddresses[].isPrimaryboolean

It differentiates the secondary addresses

siteAddresses[].addressDetailobject(AddressDetail)

siteAddresses[].lotListArray of objects(LotSectionPlan)

isApplyBehalfOnCompanybooleanrequired

Is the user applying on behalf of a company

companyNamestring<= 256 characters

Infers the name of the company. This is required if 'Is the application on behalf of a company, business or body corporate?' = Yes

ABNorACNstring<= 14 characters

Holds the ABN or ACN relating to the company. Lengths allowed are '11' for ABN and '9' for ACN. This is applicable if 'isApplyBehalfOnCompany' = true

applicantobject(Person)required

applicant.firstNamestring[ 1 .. 20 ] charactersrequired

applicant.familyNamestring[ 1 .. 20 ] charactersrequired

applicant.addressstring

applicant.contactNumberstring[ 8 .. 10 ] characters^[0-9]+$required

applicant.emailstring(email)[ 1 .. 250 ] charactersrequired

Example: "abc@yopmail.com"

councilNamestring

This is to track the council names for which the referrals are created.

officerResponsiblestringnon-emptyrequired

This infers the responsible officer in charge for the application

officerNumberstring

This infers the contact number of responsible officer in charge for the application.

officerEmailstring

This infers the email of responsible officer in charge for the application.

costOfDevelopmentnumber(decimal)required

Estimated cost of development

determinedAuthoritystring

It infers Which determining authority is expected to determine the application? One of the below mentioned values must be selected for 1. Council 2. Sydney or Regional Planning Panel 3. Local Planning Panel 4. Central Sydney Planning Committee

Example: "Refer to description for values"

panelHearingDatestring(date)

Example: "2020-18-12"

isApplicationNotifiedbooleanrequired

Is this case notified or advertised if we select isApplicationExhibited as Yes New Exhibition case will be created.

publicSubmissionEndDatestring(date)

It infers the date by which offline submission need to be received from council. By default, this is 21 days ahead of current date.

Example: "2020-18-12"

agencySelectionArray of objects(agencyAndClause)required

Infers the agency selection and it's relevant details.

agencySelection[].agencyNamestring

Name of the agency

agencySelection[].agencyOfficerEmailstring

This is to track the email of the agency officer.

agencySelection[].agencyCaseIDstring

A fully qualified agency case number.

Example: "A-XXXX"

agencySelection[].agencyCaseStatusstring

Status of the agency case.

agencySelection[].clausesArray of objects(clauseList)

The clause applicable for the corresponding agency.

agencySelection[].commentsForAgencystring<= 512 characters

Infers to comments or notes a council user would like to add for the Agency.

dateSubmittedToAgencystring(date)

The date on which agency case is submitted to agency.

Example: "2020-18-12"

documentsArray of objects(DownloadableDocument)required

This block will be sending the full set of documents.

documents[].documentNamestring[ 1 .. 150 ] charactersrequired

documentName has to be appended with file extension

Example: "test.docx"

documents[].documentTypestring[ 1 .. 100 ] charactersrequired

documents[].uploadedDateTimestring(date-time)non-emptyrequired

documents[].documentURLstring[ 1 .. 500 ] charactersrequired

URL of the document to be downloaded

documents[].documentSizenumber

This indicates the file size of the document in bytes

documents[].isSensitiveDocboolean

set this flag if you want to mark the document as sensitive

documents[].updatedBystring

Example: "Council"

deltaDocumentsArray of objects(DownloadableDocument)

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

declarationsArray of strings(CNRdeclarations)required

Example: ["Refer to description for values"]

determinationobject(RelayDetermination)

This infers as the determination stage of CNR case. Council determining CNR Case is handled as a part of UpdateCNR operation.

updatedByobject(UpdatedBy)required

updatedBy.personobject(PersonBody)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/UpdateCNR/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "string",
    "applicationType": "Refer to description for values",
    "DALodgementDate": "2020-18-12",
    "existingDANumber": "string",
    "securityConditions": true,
    "detailsOfSecurityConditions": "string",
    "originalDADeterminationDate": "2020-18-12",
    "modificationType": "Refer to description for values",
    "proposedModificationDescription": "string",
    "subjectOfReview": "Refer to description for values",
    "isExistingOnlineDA": true,
    "stateAgencyName": "string",
    "existingOnlinePANNumber": "string",
    "commonApplicationTypes": [
      {
        "commonApplicationType": "string"
      }
    ],
    "subdivisionTypes": [
      "string"
    ],
    "numOfExistingLots": 0,
    "numOfProposedLots": 0,
    "developmentType": [
      "string"
    ],
    "otherDevType": "string",
    "proposedDevelopmentTypeDescription": "string",
    "isNaturalDisaster": true,
    "siteAddresses": [
      {
        "address": "19-33 Elizabeth Street, Narrandera, 2700",
        "isPrimary": true,
        "addressDetail": {
          "complexUnitType": "string",
          "complexLevelType": "string",
          "complexLevelNumber": "string",
          "complexUnitIdentifier": "string",
          "streetNumber1": "string",
          "streetNumber2": "string",
          "streetName": "string",
          "streetSuffix": "string",
          "streetType": "string",
          "suburb": "string",
          "latitude": 0,
          "gurasID": "string",
          "longitude": 0,
          "wkid": "string",
          "cadastralID": "string",
          "primarySecondary": "string",
          "state": "string",
          "postCode": 0
        },
        "lotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX"
          }
        ]
      }
    ],
    "isApplyBehalfOnCompany": true,
    "companyName": "string",
    "ABNorACN": "string",
    "applicant": {
      "firstName": "string",
      "familyName": "string",
      "address": "string",
      "contactNumber": "stringst",
      "email": "abc@yopmail.com"
    },
    "councilName": "string",
    "officerResponsible": "string",
    "officerNumber": "string",
    "officerEmail": "string",
    "costOfDevelopment": 0,
    "determinedAuthority": "Refer to description for values",
    "panelHearingDate": "2020-18-12",
    "isApplicationNotified": true,
    "publicSubmissionEndDate": "2020-18-12",
    "agencySelection": [
      {
        "agencyName": "string",
        "agencyOfficerEmail": "string",
        "agencyCaseID": "A-XXXX",
        "agencyCaseStatus": "string",
        "clauses": [
          {
            "clauseName": "string",
            "otherClauseDescription": "string",
            "clauseType": "Refer to description for values",
            "BAMAssessment": "string",
            "reductionOfBiodiversityCredits": true
          }
        ],
        "commentsForAgency": "string"
      }
    ],
    "dateSubmittedToAgency": "2020-18-12",
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "deltaDocuments": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "declarations": [
      "Refer to description for values"
    ],
    "determination": {
      "determinationOutcome": "Refer to description for values",
      "determinationDate": "2020-09-10"
    },
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case updated

Body

Response

No content

CNRCancel

Request

This operation transfers the Council's decision to cancel the Concurrence and Referral application.

Path

CaseIDstringrequired

A fully qualified Concurrence and Referral case

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the response is originating from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

cancellationReasonstringnon-emptyrequired

Infers the reason why the case is cancelled. One of the below mentioned values must be selected for cancellationReason 1. All clauses rejected by agencies 2. DA has been withdrawn 3. Other

Example: "Refer to description for values"

cancelReasonstring

Infers the reason why the case is cancelled if 'Other' is selected.

cancellationDatestring(date)non-emptyrequired

It infers the date on which the case is cancelled

Example: "10-12-2022"

agenciesArray of objects(agencyInfo)

updatedByobject(UpdatedBy)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/CNRCancel/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "cancellationReason": "Refer to description for values",
    "cancelReason": "string",
    "cancellationDate": "10-12-2022",
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case Cancelled

Body

Response

No content

CNRPaymentNotification

Request

This operation transfers the payment done by applicant on CNR application from ePlanning's IT system to Agency's IT System.

Path

CaseIDstringrequired

A fully qualified Concurrence and Referral case Number

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 80 characters

Status of the payment case

Example: "Paid"

paymentStatusstring

It infers the current status of payment

Example: "Approved"

caseRefstring<= 32 characters

It infers the CNR case number corresponding to which payment case is created

Example: "CNR-XXXX"

existingDANumberstring<= 50 characters

It infers the DA number to which the Payment is being requested

paymentReferenceNumberstring

Payment reference number

totalAmountnumber(decimal)

Amount of payment done by applicant

paymentDueDatestring(date)

It infers the date by which the payment has to be made by applicant

Example: "2021-03-18"

paymentTransDatestring(date)

Date of Payment

Example: "2021-03-18"

agenciesArray of objects(agencyInfo)

documentsArray of objects(DownloadableDocument)

updatedByobject(UpdatedBy)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/CNRPaymentNotification/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Paid",
    "paymentStatus": "Approved",
    "caseRef": "CNR-XXXX",
    "existingDANumber": "string",
    "paymentReferenceNumber": "string",
    "totalAmount": 0,
    "paymentDueDate": "2021-03-18",
    "paymentTransDate": "2021-03-18",
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Payment successful

Body

Response

No content

CNRUploadAgencyCommunication

Request

This operation transfers the communication document uploaded by the council on the CNR case to the Agency's IT system.

Path

CaseIDstringrequired

A fully qualified Concurrence and Referral case number

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 32 characters

Status of the CNR case

agenciesArray of objects(agencyInfo)

uploadAgencyCommunicationDocumentsArray of objects(DownloadableDocument)

updatedByobject(UpdatedBy)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/CNRUploadAgencyCommunication/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "string",
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "uploadAgencyCommunicationDocuments": [
      {
        "agencyName": "string",
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Document uploaded successfully

Body

Response

No content

CNRUploadSubmission

Request

This operation transfers the Public submission documents(related to DA Exhibition) uploaded by the council on the CNR case to the Agency's IT system.

Path

CaseIDstringrequired

A fully qualified Concurrence and Referral case number

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 32 characters

Status of the CNR case

noSubmissionRcvdboolean

It infers that there is no public submission has been received around the request.

closingDatestring(date)

It infers the expected closing date for public submission.

agenciesArray of objects(agencyInfo)

documentsArray of objects(DownloadableDocument)

updatedByobject(UpdatedBy)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/CNRUploadSubmission/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "string",
    "noSubmissionRcvd": true,
    "closingDate": "2019-08-24",
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Document uploaded successfully

Body

Response

No content

WithdrawAgency

Request

This operation transfers Council decision to withdraw particular agency application.

Path

CaseIDstringrequired

A fully qualified Agency Concurrence and Referral case number

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 32 characters

Status of the Agency CNR case

CNRCaseIDstring<= 32 characters

CNR Case ID.

Example: "CNR-XXX"

withdrawalDatestring(date)non-emptyrequired

Date on which case is withdrawn

withdrawalReasonstring

Reason for which the case is withdrawn

agencyBeingWithrawnstring<= 256 characters

Agency name withdrawn by council

agenciesArray of objects(agencyInfo)

documentsArray of objects(DownloadableDocument)

updatedByobject(UpdatedBy)required

updatedBy.personobject(PersonBody)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/WithdrawAgency/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "string",
    "CNRCaseID": "CNR-XXX",
    "withdrawalDate": "2019-08-24",
    "withdrawalReason": "string",
    "agencyBeingWithrawn": "string",
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "https://api-tst.apps1.nsw.gov.au/planning/external/v1/Documents/Doc2",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

case updated

Body

Response

No content

CNRUpdateMetadata

Request

This operation enables user to mark or update sensitive and assessment documents.

Path

CaseIDstringrequired

A fully qualified application number or case id

Headers

OrganisationIDstringrequired

Used by the API gateway to route the request to the council's API endpoint.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 32 characters

Status of the Concurrence and Referral case

Example: "submitted"

agenciesArray of objects(agencyInfo)

documentsArray of objects(DocumentsInfo)

updatedByobject(UpdatedBy)required

updatedBy.personobject(PersonBody)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/CNRUpdateMetadata/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "submitted",
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "documents": [
      {
        "docType": "Fee estimate",
        "attachments": [
          {
            "docID": "DATA-WORKATTACH-FILE PEC-DPE-EP-WORK CDC-7850!20201124T125127.562 GMT",
            "docName": "FeeEstimate_1619732080.pdf",
            "isSensitiveDoc": true
          }
        ]
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Metadata updated successfully.

Body

CNRUpdateAdditionalInfo

Request

This operation transfers the additional information provided by Council (requested by particular Agency) from ePlanning's IT system to the Agency's IT System.

Path

CaseIDstringrequired

A fully qualified application number or case id

Headers

OrganisationIDstringrequired

Used by the API gateway to route the request to the council's API endpoint.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 32 characters

Status of the Concurrence and Referral case

Example: "submitted"

additionalInfoProvidedboolean(Does the applicant agree to provide the information)

it infers whether the applicant agrees to provide the information requested

allAdditionalInfoRequestsArray of objects(ProvideAdditionalInfo)

The additional information requests made earlier.

agenciesArray of objects(agencyInfo)

documentsArray of objects(DownloadableDocument)

Documnets uploaded by council. only applicable when additionalInfoProvided is- "true"

updatedByobject(UpdatedBy)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/CNRUpdateAdditionalInfo/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "submitted",
    "additionalInfoProvided": true,
    "allAdditionalInfoRequests": [
      {
        "isRespond": true,
        "agencyRequestedAI": "string",
        "agencyCaseID": "A-XXXX",
        "comments": "string",
        "status": "string",
        "requestDate": "2021-03-18",
        "responseDate": "2021-03-18",
        "councilComments": "string"
      }
    ],
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "https://api-tst.apps1.nsw.gov.au/planning/external/v1/Documents/Doc2",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

case updated

Body

RelayCNRUpdateAdditionalInfo

Request

This operation transfers the updates of other agencies through relay when council provides additional information (requested by particular Agency)from ePlanning's IT system to the Agency's IT System.

Path

CaseIDstringrequired

A fully qualified application number or case id

Headers

OrganisationIDstringrequired

Used by the API gateway to route the request to the council's API endpoint.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 32 characters

Status of the Concurrence and Referral case

Example: "submitted"

additionalInfoProvidedboolean(Does the applicant agree to provide the information)

it infers whether the applicant agrees to provide the information requested

allAdditionalInfoRequestsArray of objects(ProvideAdditionalInfo)

The additional information requests made earlier.

agenciesArray of objects(agencyInfo)

documentsArray of objects(DownloadableDocument)

Documnets uploaded by council. only applicable when additionalInfoProvided is- "true"

updatedByobject(UpdatedBy)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/RelayCNRUpdateAdditionalInfo/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "submitted",
    "additionalInfoProvided": true,
    "allAdditionalInfoRequests": [
      {
        "isRespond": true,
        "agencyRequestedAI": "string",
        "agencyCaseID": "A-XXXX",
        "comments": "string",
        "status": "string",
        "requestDate": "2021-03-18",
        "responseDate": "2021-03-18",
        "councilComments": "string"
      }
    ],
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "https://api-tst.apps1.nsw.gov.au/planning/external/v1/Documents/Doc2",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

case updated.

Body

RelayUploadAgencyCommunication

Request

This operation transfers the updates of other agencies use Relay Function.This operation transfers the communication document uploaded by the council on the CNR case to the Agency's IT system.

Path

CaseIDstringrequired

A fully qualified Concurrence and Referral case number

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 32 characters

Status of the CNR case

agenciesArray of objects(agencyInfo)

uploadAgencyCommunicationDocumentsArray of objects(DownloadableDocument)

updatedByobject(UpdatedBy)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/RelayUploadAgencyCommunication/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "string",
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "uploadAgencyCommunicationDocuments": [
      {
        "agencyName": "string",
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Document uploaded successfully

Body

Response

No content

RelayCNRReassign

Request

This operation provides updates on reassigning CNR Council case officer to Agency's IT System. CNR Case is re-assigned to another Case Officer within same council .

Path

CaseIDstringrequired

A fully qualified Portal Application Number (Case ID).

Headers

OrganisationIDstringrequired

Used by the API gateway to route the request to the council's API endpoint

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

assigneeobject(UpdatedBy)required

assignee.personobject(PersonBody)

updatedByobject(UpdatedBy)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/RelayCNRReassign/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "assignee": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    },
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case reassigned

Body

Response

No content

RelayWithdrawAgency

Request

This operation transfers Council decision to withdraw particular Agency.Relay Function provide updates of other agencies. application.

Path

CaseIDstringrequired

A fully qualified Agency Concurrence and Referral case number

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 32 characters

Status of the Agency CNR case

CNRCaseIDstring<= 32 characters

CNR Case ID.

Example: "CNR-XXX"

withdrawalDatestring(date)non-emptyrequired

Date on which case is withdrawn

withdrawalReasonstring

Reason for which the case is withdrawn

agencyBeingWithrawnstring<= 256 characters

Agency name withdrawn by council

agenciesArray of objects(agencyInfo)

documentsArray of objects(DownloadableDocument)

updatedByobject(UpdatedBy)required

updatedBy.personobject(PersonBody)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/RelayWithdrawAgency/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "string",
    "CNRCaseID": "CNR-XXX",
    "withdrawalDate": "2019-08-24",
    "withdrawalReason": "string",
    "agencyBeingWithrawn": "string",
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "https://api-tst.apps1.nsw.gov.au/planning/external/v1/Documents/Doc2",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

case withdrawn

Body

Response

No content

RelayAgencyAcceptReturn

Request

To get updates of other agencies use Relay Function .This operation transfers the agency's pre-assessment(accepted,Rejected etc)on Agency application from agency's IT system to the ePlanning's IT System."

Path

CaseIDstringrequired

A fully qualified Agency Concurrence and Referral case. E.g. A-xxx case

Headers

OrganisationIDstringrequired

The council LGA name or Agency Organisation name to indicate where the request has originated from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

isAgencyAssessmentReqstring(AgencyAssessment)required

Is agency assessment required? "Accept all","Reject all" and "Accept/Reject individually" are only applicable when agency has more than one clause. One of the below mentioned values must be selected for AgencyAssessment 1. Accept 2. Reject 3. Accept all 4. Reject all 5. Accept/Reject individually

Example: "Refer to description for values"

rejectReasonstring(Please provide reason)

This infers that the agency need to provide the reason for which the assessment is not required. Mandatory when 'isAgencyAssessmentReq' is- 'Reject' OR 'Reject All'

CNRCaseIDstring

Holds CNR Case ID

Example: "CNR-XXX"

agencyToBeAssessedstring

This Infers Agencyname which is performing Preassessment .

agencyOfficerstring(Assign case to)<= 32 characters

applicable when isAgencyAssessmentReq is "Accept" or "Accept all"

clauseDetailsArray of objects(ClauseDetails)

documentsArray of objects(DownloadableDocument)

Documents will be avaialble if the isAgencyAssessmentReq is 'Reject' OR 'Reject All'

agenciesArray of objects(agencyInfo)

updatedByobject(UpdatedBy)required

updatedBy.personobject(PersonBody)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/RelayAgencyAcceptReturn/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "isAgencyAssessmentReq": "Refer to description for values",
    "rejectReason": "string",
    "CNRCaseID": "CNR-XXX",
    "agencyToBeAssessed": "string",
    "agencyOfficer": "string",
    "clauseDetails": [
      {
        "isAgencyAssessmentReq": "Refer to description for values",
        "rejectReason": "string",
        "clauseName": "string",
        "clauseType": "Refer to description for values"
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "https://api-tst.apps1.nsw.gov.au/planning/external/v1/Documents/Doc2",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case Submitted by Applicant

Body

Response

No content

RelayAgencyDecision

Request

This operation transfers particular agency's decision(approve, approve (with conditions),Refuse, Advice, Decision not required ) from agency's IT system to ePlanning's IT System. This is to get updates of other agencies using Relay Function .

Path

CaseIDstringrequired

A fully qualified Agency Concurrence and Referral case. E.g. A-xxx case

Headers

OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

IdempotencyIDstringrequired

Bodyapplication/jsonrequired

Information request object

caseStatusstring

Status of the Agency case

CNRCaseIDstring

Holds CNR Case ID

Example: "CNR-XXX"

agencyProvidingDecisionstring

This Infers Agencyname which is performing Decision.

agencyResponsestring(DecisionOutcome)required

It infers the outcome of the decision on the Agency case A-xxx given by agency. One of the below mentioned values must be selected for DecisionOutcome 1. Approve (with conditions) 2. Approve 3. Refuse 4. Advice 5. Decision not required

Example: "Refer to description for values"

decisionCommentsstring

It infers the comments from the agency if they have selected agency response as 'Refuse' OR 'Decision not required'. It is mandatory when agency response is 'Decision not required'

agenciesArray of objects(agencyInfo)

documentsArray of objects(DownloadableDocument)

updatedByobject(UpdatedBy)required

updatedBy.personobject(PersonBody)

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/RelayAgencyDecision/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "string",
    "CNRCaseID": "CNR-XXX",
    "agencyProvidingDecision": "string",
    "agencyResponse": "Refer to description for values",
    "decisionComments": "string",
    "agencies": [
      {
        "agencyName": "string",
        "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX  Applicable only for '\''Biodiversity'\'' Clause)",
        "agencyCaseStatus": "string",
        "agencyAmount": 0
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "isSensitiveDoc": true,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

case updated

Body

Response

No content

Concurrence and Referral - ePlanning to Agency API (v1)

Authentication

CreateCNR

RequestExpand all

Responses

Was this helpful?

UpdateCNR

RequestExpand all

Responses

Was this helpful?

CNRCancel

RequestExpand all

Responses

Was this helpful?

CNRPaymentNotification

RequestExpand all

Responses

Was this helpful?

CNRUploadAgencyCommunication

RequestExpand all

Responses

Was this helpful?

CNRUploadSubmission

RequestExpand all

Responses

Was this helpful?

WithdrawAgency

RequestExpand all

Responses

Was this helpful?

CNRUpdateMetadata

RequestExpand all

Responses

Was this helpful?

CNRUpdateAdditionalInfo

RequestExpand all

Responses

Was this helpful?

RelayCNRUpdateAdditionalInfo

RequestExpand all

Responses

Was this helpful?

RelayUploadAgencyCommunication

RequestExpand all

Responses

Was this helpful?

RelayCNRReassign

RequestExpand all

Responses

Was this helpful?

RelayWithdrawAgency

RequestExpand all

Responses

Was this helpful?

RelayAgencyAcceptReturn

RequestExpand all

Responses

Was this helpful?

RelayAgencyDecision

RequestExpand all

Responses

Was this helpful?

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request