NotificationOfNODStatus

This operation provides the NOD document's generation status and review letter generation status for review DA cases along with the document details to the consent authority. This operation also provides all the conditions used to generate the NOD for that case. For any Bespoke conditions which are not present in the DPE Council library, this API will assign a case specific Condition ID. This Condition ID should be stored for that case in the council system. This Condition ID should be passed in ConsentConditions API during Mod and Review of a DA if the same condition needs to be retained.

path Parameters
CaseID
required
string

A fully qualified application number

header Parameters
OrganisationID
required
string

Used by the API gateway to route the request to the relevant organisation.

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

NotificationOfNODStatus request object

NODGenenerationStatus
required
string

This indicates the status of NOD generation

Array of objects (DocumentDetails)

This gets populated when NOD is successfully generated

failureReason
string

This indicates the reason as to why the NOD document generation is failed.This is relevant for NOD failure scenarios only.

Array of objects (ConditionsDetails)

This indicates the conditons related to a specific case

Responses

Request samples

Content type
application/json
{
  • "NODGenenerationStatus": "Success",
  • "documents": [
    ],
  • "failureReason": "Condition's validation faliure text",
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "Request is successfully executed"
}
Next to CreateContribution