RelayAgencyDecision

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 Parameters
CaseID
required
string

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

header Parameters
OrganisationID
required
string

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

IdempotencyID
required
string

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"

Request Body schema: application/json

Information request object

caseStatus
string

Status of the Agency case

CNRCaseID
string

Holds CNR Case ID

agencyProvidingDecision
string

This Infers Agencyname which is performing Decision.

agencyResponse
required
string (DecisionOutcome)

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

decisionComments
string

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'

Array of objects (agencyInfo)
Array of objects (DownloadableDocument)
required
object (UpdatedBy)

Responses

Request samples

Content type
application/json
{
  • "caseStatus": "string",
  • "CNRCaseID": "CNR-XXX",
  • "agencyProvidingDecision": "string",
  • "agencyResponse": "Refer to description for values",
  • "decisionComments": "string",
  • "agencies": [
    ],
  • "documents": [
    ],
  • "updatedBy": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": 404,
  • "message": "Internal Server error 19876",
  • "activityId": "00000011-0ab-xy00-0000-500000000000",
  • "errorCode": "DPE_TMS01",
  • "errorDetails": "Inner Exceptions, Stack Trace, etc"
}