ProvideAddInfo

This operation transfers additional information uploaded by the relevant organisation's IT system to the ePlanning. This operation is applicable to certificate registration Service and referral cases.

path Parameters
CaseID
required
string

A fully qualified application number

header Parameters
OrganisationID
required
string

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

body

provideDetails
required
string <= 512 characters

This is to track the description of the response, required when certifier is providing additional information

childCaseID
string

Required only if responding to an existing AI case id for RFI

Array of objects (DownloadableDocument)
updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal

Responses

Request samples

Content type
application/json
{
  • "provideDetails": "string",
  • "childCaseID": "string",
  • "Documents": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "Additional Information Provided",
  • "activityId": "string",
  • "Documents": [
    ]
}
Next to Withdraw