UpdateExhibition

This operation transfers the exhibition details from the relevant organisation to update the exhibition in the ePlanning system.

path Parameters
CaseID
required
string

A fully qualified exhibition case 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
exhibitionStartDate
string <date>

This is to track the start date of the exhibition. This field is not applicable when the case status in 'On Exhibition' status.

exhibitionEndDate
required
string <date>

This is to track the end date of the exhibition and this field is mandatory when the applicant select doesPublicExhibitionRequired is selected as true.

comments
string <= 512 characters

This is an optional field to provide comments in the exhibition details screen. This can be used during creation or updating the exhibition.

detailedDescription
string

This field is applicable for State DA and Mandatory to provide detailed description in Exhibition details screen. This can be used during creation or updating the exhibition.

Array of objects (NewsPaper)
Array of objects (DocumentsToUpload)
Array of objects (DocumentsToPublish)

this is to publish the existing documents

updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal

Responses

Request samples

Content type
application/json
{
  • "exhibitionStartDate": "2019-08-24",
  • "exhibitionEndDate": "2019-08-24",
  • "comments": "string",
  • "detailedDescription": "string",
  • "addNewsPaper": [
    ],
  • "Documents": [
    ],
  • "DocumentsToPublish": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "Case updated",
  • "activityId": "string",
  • "Documents": [
    ]
}
Next to CreateSubmission