@planning-inspectorate/data-model 1.11.0

package/docs/nsip-exam-timetable.md

@@ -0,0 +1,352 @@
+## Examination Timetable Type
+
+`object` ([Examination Timetable](nsip-exam-timetable.md))
+
+# Examination Timetable Properties
+
+| Property                        | Type      | Required | Nullable       | Defined by                                                                                                                           |
+| :------------------------------ | :-------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------- |
+| [caseReference](#casereference) | `string`  | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-properties-casereference.md "nsip-exam-timetable.schema.json#/properties/caseReference") |
+| [published](#published)         | `boolean` | Optional | can be null    | [Examination Timetable](nsip-exam-timetable-properties-published.md "nsip-exam-timetable.schema.json#/properties/published")         |
+| [events](#events)               | `array`   | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-properties-events.md "nsip-exam-timetable.schema.json#/properties/events")               |
+| Additional Properties           | Any       | Optional | can be null    |                                                                                                                                      |
+
+## caseReference
+
+Unique string reference of the associated Case
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-properties-casereference.md "nsip-exam-timetable.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+## published
+
+whether the Examination Timetable has been published or not
+
+`published`
+
+* is optional
+
+* Type: `boolean`
+
+* can be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-properties-published.md "nsip-exam-timetable.schema.json#/properties/published")
+
+### published Type
+
+`boolean`
+
+## events
+
+
+
+`events`
+
+* is required
+
+* Type: `object[]` ([Details](nsip-exam-timetable-defs-event.md))
+
+* cannot be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-properties-events.md "nsip-exam-timetable.schema.json#/properties/events")
+
+### events Type
+
+`object[]` ([Details](nsip-exam-timetable-defs-event.md))
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema
+
+# Examination Timetable Definitions
+
+## Definitions group event
+
+Reference this group by using
+
+```json
+{"$ref":"nsip-exam-timetable.schema.json#/$defs/event"}
+```
+
+| Property                                          | Type      | Required | Nullable       | Defined by                                                                                                                                                                    |
+| :------------------------------------------------ | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [eventId](#eventid)                               | `integer` | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventid.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventId")                               |
+| [type](#type)                                     | `string`  | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-type.md "nsip-exam-timetable.schema.json#/$defs/event/properties/type")                                     |
+| [eventTitle](#eventtitle)                         | `string`  | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventtitle.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventTitle")                         |
+| [eventTitleWelsh](#eventtitlewelsh)               | `string`  | Optional | can be null    | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventtitlewelsh.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventTitleWelsh")               |
+| [description](#description)                       | `string`  | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-description.md "nsip-exam-timetable.schema.json#/$defs/event/properties/description")                       |
+| [descriptionWelsh](#descriptionwelsh)             | `string`  | Optional | can be null    | [Examination Timetable](nsip-exam-timetable-defs-event-properties-descriptionwelsh.md "nsip-exam-timetable.schema.json#/$defs/event/properties/descriptionWelsh")             |
+| [eventDeadlineStartDate](#eventdeadlinestartdate) | `string`  | Optional | can be null    | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventdeadlinestartdate.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventDeadlineStartDate") |
+| [date](#date)                                     | `string`  | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-date.md "nsip-exam-timetable.schema.json#/$defs/event/properties/date")                                     |
+| [eventLineItems](#eventlineitems)                 | `array`   | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventlineitems.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventLineItems")                 |
+| Additional Properties                             | Any       | Optional | can be null    |                                                                                                                                                                               |
+
+### eventId
+
+Event Identifier
+
+`eventId`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventid.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventId")
+
+#### eventId Type
+
+`integer`
+
+### type
+
+Compulsory Acquisition Hearing/Deadline/Issue Specific Hearing etc
+
+`type`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-type.md "nsip-exam-timetable.schema.json#/$defs/event/properties/type")
+
+#### type Type
+
+`string`
+
+#### type Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                                     | Explanation |
+| :---------------------------------------- | :---------- |
+| `"Accompanied Site Inspection"`           |             |
+| `"Compulsory Acquisition Hearing"`        |             |
+| `"Deadline"`                              |             |
+| `"Deadline For Close Of Examination"`     |             |
+| `"Issued By"`                             |             |
+| `"Issue Specific Hearing"`                |             |
+| `"Open Floor Hearing"`                    |             |
+| `"Other Meeting"`                         |             |
+| `"Preliminary Meeting"`                   |             |
+| `"Procedural Deadline (Pre-Examination)"` |             |
+| `"Procedural Decision"`                   |             |
+| `"Publication Of"`                        |             |
+
+### eventTitle
+
+Title Of Examination Timetable Event
+
+`eventTitle`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventtitle.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventTitle")
+
+#### eventTitle Type
+
+`string`
+
+### eventTitleWelsh
+
+Title Of Examination Timetable Event In Welsh
+
+`eventTitleWelsh`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventtitlewelsh.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventTitleWelsh")
+
+#### eventTitleWelsh Type
+
+`string`
+
+### description
+
+
+
+`description`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-description.md "nsip-exam-timetable.schema.json#/$defs/event/properties/description")
+
+#### description Type
+
+`string`
+
+### descriptionWelsh
+
+
+
+`descriptionWelsh`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-descriptionwelsh.md "nsip-exam-timetable.schema.json#/$defs/event/properties/descriptionWelsh")
+
+#### descriptionWelsh Type
+
+`string`
+
+### eventDeadlineStartDate
+
+Optional start date for event window
+
+`eventDeadlineStartDate`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventdeadlinestartdate.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventDeadlineStartDate")
+
+#### eventDeadlineStartDate Type
+
+`string`
+
+#### eventDeadlineStartDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+#### eventDeadlineStartDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+### date
+
+Event Date = effective deadline (end) date
+
+`date`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-date.md "nsip-exam-timetable.schema.json#/$defs/event/properties/date")
+
+#### date Type
+
+`string`
+
+#### date Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+#### date Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+### eventLineItems
+
+
+
+`eventLineItems`
+
+* is required
+
+* Type: `object[]` ([Details](nsip-exam-timetable-defs-line-item.md))
+
+* cannot be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventlineitems.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventLineItems")
+
+#### eventLineItems Type
+
+`object[]` ([Details](nsip-exam-timetable-defs-line-item.md))
+
+### Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema
+
+## Definitions group line-item
+
+Reference this group by using
+
+```json
+{"$ref":"nsip-exam-timetable.schema.json#/$defs/line-item"}
+```
+
+| Property                                | Type     | Required | Nullable       | Defined by                                                                                                                                                                |
+| :-------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [description](#description-1)           | `string` | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-line-item-properties-description.md "nsip-exam-timetable.schema.json#/$defs/line-item/properties/description")           |
+| [descriptionWelsh](#descriptionwelsh-1) | `string` | Optional | can be null    | [Examination Timetable](nsip-exam-timetable-defs-line-item-properties-descriptionwelsh.md "nsip-exam-timetable.schema.json#/$defs/line-item/properties/descriptionWelsh") |
+| Additional Properties                   | Any      | Optional | can be null    |                                                                                                                                                                           |
+
+### description
+
+
+
+`description`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-line-item-properties-description.md "nsip-exam-timetable.schema.json#/$defs/line-item/properties/description")
+
+#### description Type
+
+`string`
+
+### descriptionWelsh
+
+
+
+`descriptionWelsh`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Examination Timetable](nsip-exam-timetable-defs-line-item-properties-descriptionwelsh.md "nsip-exam-timetable.schema.json#/$defs/line-item/properties/descriptionWelsh")
+
+#### descriptionWelsh Type
+
+`string`
+
+### Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/nsip-project-update.md

@@ -0,0 +1,163 @@
+## NSIP Project Update Type
+
+`object` ([NSIP Project Update](nsip-project-update.md))
+
+# NSIP Project Update Properties
+
+| Property                                      | Type      | Required | Nullable       | Defined by                                                                                                                                       |
+| :-------------------------------------------- | :-------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------- |
+| [id](#id)                                     | `integer` | Required | cannot be null | [NSIP Project Update](nsip-project-update-properties-id.md "nsip-project-update.schema.json#/properties/id")                                     |
+| [caseReference](#casereference)               | `string`  | Required | cannot be null | [NSIP Project Update](nsip-project-update-properties-casereference.md "nsip-project-update.schema.json#/properties/caseReference")               |
+| [updateDate](#updatedate)                     | `string`  | Required | can be null    | [NSIP Project Update](nsip-project-update-properties-updatedate.md "nsip-project-update.schema.json#/properties/updateDate")                     |
+| [updateName](#updatename)                     | `string`  | Required | can be null    | [NSIP Project Update](nsip-project-update-properties-updatename.md "nsip-project-update.schema.json#/properties/updateName")                     |
+| [updateContentEnglish](#updatecontentenglish) | `string`  | Required | cannot be null | [NSIP Project Update](nsip-project-update-properties-updatecontentenglish.md "nsip-project-update.schema.json#/properties/updateContentEnglish") |
+| [updateContentWelsh](#updatecontentwelsh)     | `string`  | Required | can be null    | [NSIP Project Update](nsip-project-update-properties-updatecontentwelsh.md "nsip-project-update.schema.json#/properties/updateContentWelsh")     |
+| [updateStatus](#updatestatus)                 | `string`  | Required | cannot be null | [NSIP Project Update](nsip-project-update-properties-updatestatus.md "nsip-project-update.schema.json#/properties/updateStatus")                 |
+| Additional Properties                         | Any       | Optional | can be null    |                                                                                                                                                  |
+
+## id
+
+The unique identifier within the Back Office.
+
+`id`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [NSIP Project Update](nsip-project-update-properties-id.md "nsip-project-update.schema.json#/properties/id")
+
+### id Type
+
+`integer`
+
+## caseReference
+
+the case reference this update relates to
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [NSIP Project Update](nsip-project-update-properties-casereference.md "nsip-project-update.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+## updateDate
+
+The date the update was published
+
+`updateDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project Update](nsip-project-update-properties-updatedate.md "nsip-project-update.schema.json#/properties/updateDate")
+
+### updateDate Type
+
+`string`
+
+### updateDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+## updateName
+
+Internal title or name of the update
+
+`updateName`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project Update](nsip-project-update-properties-updatename.md "nsip-project-update.schema.json#/properties/updateName")
+
+### updateName Type
+
+`string`
+
+## updateContentEnglish
+
+HTML content of the update in English. Can only include `<a> <b> <ul> <li>` tags.
+
+`updateContentEnglish`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [NSIP Project Update](nsip-project-update-properties-updatecontentenglish.md "nsip-project-update.schema.json#/properties/updateContentEnglish")
+
+### updateContentEnglish Type
+
+`string`
+
+## updateContentWelsh
+
+HTML content of the update in Welsh. Can only include `<a> <b> <ul> <li>` tags.
+
+`updateContentWelsh`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project Update](nsip-project-update-properties-updatecontentwelsh.md "nsip-project-update.schema.json#/properties/updateContentWelsh")
+
+### updateContentWelsh Type
+
+`string`
+
+## updateStatus
+
+The current status of this update
+
+`updateStatus`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [NSIP Project Update](nsip-project-update-properties-updatestatus.md "nsip-project-update.schema.json#/properties/updateStatus")
+
+### updateStatus Type
+
+`string`
+
+### updateStatus Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                  | Explanation |
+| :--------------------- | :---------- |
+| `"draft"`              |             |
+| `"ready-to-publish"`   |             |
+| `"published"`          |             |
+| `"ready-to-unpublish"` |             |
+| `"unpublished"`        |             |
+| `"archived"`           |             |
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema