Lodging Events - ministryofjustice/hmpps-book-secure-move-api GitHub Wiki

This page documents lodging events in the Book A Secure Move API

LodgingCreate

Description

Indicates that an overnight lodging is planned to take place during a move.

Attributes

  • start_date - The date that the lodging will start
  • end_date - The date that the lodging will end
  • location - The location that the lodging will take place at

Request Example

Created automatically when a lodging is created via the lodgings controller.

Validations

  • start_date - presence, iso8601 date time
  • end_date - presence, iso8601 date time
  • location - presence, must be an existing location

Triggers

None

LodgingUpdate

Description

Indicates that the details of an overnight lodging have changed.

Attributes

  • start_date and old_start_date - The original and new dates that the lodging will start
  • end_date and old_end_date - The original and new dates that the lodging will end
  • location_id and old_location_id - The original and new locations that the lodging will take place at

Request Example

Created automatically when a lodging is updated via the lodgings controller.

Validations

One of the following pairs of attributes must be present:

  • start_date and old_start_date - iso8601 date times
  • end_date and old_end_date - iso8601 date times
  • location_id and old_location_id - IDs of existing locations

Triggers

None

LodgingCancel

Description

Indicates that an overnight lodging has been cancelled for a move.

Attributes

  • start_date - The date that the lodging will start
  • end_date - The date that the lodging will end
  • cancellation_reason - The reason code for the cancellation
  • cancellation_reason_comment - Optional comment about why the lodging was cancelled

Request Example

Created automatically when a lodging is cancelled via the lodgings controller.

Validations

  • start_date - presence, iso8601 date time
  • end_date - presence, iso8601 date time
  • cancellation_reason - presence, must be one of: (made_in_error | supplier_declined_to_move | cancelled_by_pmu | other)

Triggers

None