Skip to content
ONLINE Concurrence and Referral SERVICE APIs V1
/
Concurrence and Referral Agency to ePlanning API
/
AcceptReturn

Concurrence and Referral - Agency to ePlanning API (v1)

Authentication

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

Download OpenAPI description
CNR - Agency to ePlanning API v1.0.json
CNR - Agency to ePlanning API v1.0.yaml
Overview
Languages
Servers

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

AcceptReturn

Request

This operation transfers the agency's decision to accept or return the application from agency's IT system to 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

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

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 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)<= 2000 characters

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'

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 available if the isAgencyAssessmentReq is 'Reject' OR 'Reject All'

updatedByEmailstring(UpdatedByEmail)required

user mail address who performing the action.

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineCNR/v1/AcceptReturn/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "isAgencyAssessmentReq": "Refer to description for values",
    "rejectReason": "string",
    "agencyOfficer": "string",
    "clauseDetails": [
      {
        "isAgencyAssessmentReq": "Refer to description for values",
        "rejectReason": "string",
        "clauseName": "string"
      }
    ],
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string"
      }
    ],
    "updatedByEmail": "string"
  }'

Responses

Case Submitted by Applicant

Bodyapplication/json
documentNamestring

Document name which was uploaded as part of respective API opeartion

Example: "test.docx"
documentTypestring

Type of Document under which repsective document was uploaded

eplanningDocIdstring

Document Id of the respective document which was uploaded

externalOrgDocURLstring

URL of the document which was uploaded

Response
application/json
{
  "documentName": "test.docx",
  "documentType": "string",
  "eplanningDocId": "string",
  "externalOrgDocURL": "string"
}

Assessment

Request

This operation transfers the particulars of the agency's request from agency's IT System to ePlanning's IT system. In this operation agency requests for additional information from council when required. When additional information is not required, the case is progressed to the subsequent stage.

Path
CaseIDstringrequired

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

Headers
OrganisationIDstringrequired

The agency 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

canContinueAssessmentboolean

it infers whether information provided by Council is sufficient for the assessment process. This is applicable when the Council confirms that the Applicant is willing to provide the additional information requested.

moreInfoReqdboolean

it infers if more information is required from the Council on behalf of the applicant, for the assessment process? This will be applicable when 'canContinueAssessment' is false.

detailsOfRequeststring<= 256 characters

It infers about the details of information request and is applicable if 'moreInfoReqd' is true

requestDatestring(date)

Date of request for additional information

Example: "2021-03-18"
DocumentsArray of objects(DownloadableDocument)
updatedByEmailstring(UpdatedByEmail)

user mail address who performing the action.

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineCNR/v1/Assessment/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "canContinueAssessment": true,
    "moreInfoReqd": true,
    "detailsOfRequest": "string",
    "requestDate": "2021-03-18",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string"
      }
    ],
    "updatedByEmail": "string"
  }'

Responses

Case updated

Bodyapplication/json
documentNamestring

Document name which was uploaded as part of respective API opeartion

Example: "test.docx"
documentTypestring

Type of Document under which repsective document was uploaded

eplanningDocIdstring

Document Id of the respective document which was uploaded

externalOrgDocURLstring

URL of the document which was uploaded

Response
application/json
{
  "documentName": "test.docx",
  "documentType": "string",
  "eplanningDocId": "string",
  "externalOrgDocURL": "string"
}

Decision

Request

This operation transfers the particulars of the agency's decision from agency's IT system to ePlanning's IT System. These are the various decisions that the agency could make - approve(withconditions),approve, refuse, Advice, Decision not required ).

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

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 One of the below mentioned values must be selected for determinedAuthority 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'

DocumentsArray of objects(DownloadableDocument)
updatedByEmailstring(UpdatedByEmail)required

user mail address who performing the action.

curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineCNR/v1/Decision/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "agencyResponse": "Refer to description for values",
    "decisionComments": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string"
      }
    ],
    "updatedByEmail": "string"
  }'

Responses

Case decision is completed

Bodyapplication/json
documentNamestring

Document name which was uploaded as part of respective API opeartion

Example: "test.docx"
documentTypestring

Type of Document under which repsective document was uploaded

eplanningDocIdstring

Document Id of the respective document which was uploaded

externalOrgDocURLstring

URL of the document which was uploaded

Response
application/json
{
  "documentName": "test.docx",
  "documentType": "string",
  "eplanningDocId": "string",
  "externalOrgDocURL": "string"
}
© 2025 Your Company. All Rights Reserved.