ReferralAssessment

This operation sends the information of the assessment of Referrals to Certifier's IT system.

path Parameters
CaseID
required
string

A fully qualified application number or case id

header Parameters
OrganisationID
required
string

The council LGA name or Private Certifier or Agency Organisation 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

primaryCaseID
string

This is to track the Post Consent Certificate case ID.

caseStatus
required
string [ 1 .. 80 ] characters

Status of the Referral case

object (agencyToConsultWith)

Add agency

reviewOfOutcome
required
string (ReviewOfOutcome)

This is to track the outcome of the review One of the below mentioned values are applicable for ReviewOfOutcome. Please refer to the reference data API for the latest values. 1 . Accept application 2. Return application 3. Referral noted, decision not required

preliminaryReview
string (Preliminary Review)

This is to track the Preliminary review outcome. Applicable if the reviewOfOutcome is 'Accept application'. One of the below mentioned values to be selected for PreliminaryReview. Please refer to the reference data API for the latest values. 1. Yes, the application is ready for decision 2. No, need more information

retunApplication
string <= 1500 characters

This is to track the reviewoutcome. Required if the reviewOfOutcome is 'Return application'

commentsOnDecisionNotRequired
string <= 1500 characters

This is to track the the comments, when the decision is not required. This becomes application when reviewOfOutcome is 'Referral noted, decision not required'

Array of objects (DownloadableDocument)

This is to track the Documents avialble if the reviewOfOutcome is 'Return application'

required
object (updatedBy)

Responses

Request samples

Content type
application/json
{
  • "primaryCaseID": "CFT-XXXX",
  • "caseStatus": "Submitted",
  • "referralDetails": {
    },
  • "reviewOfOutcome": "Refer to description for values",
  • "preliminaryReview": "Refer to description for values",
  • "retunApplication": "string",
  • "commentsOnDecisionNotRequired": "string",
  • "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"
}
Next to ReferralDecision