Interface role
The Long Term Planning interface allows for the creation, modification and retrieval of long term planning data held within the ASM Support System. It is not foreseen that one ASM Support System may create long term planning in another ASM Support System and so the creation and update mechanisms may be limited to External Users acting as a user of the ASM Support System under the External ASM User - ASM Support System use of the service case.
Figure 12 in Section 2.4.4.1 provides an overview of the Long Term Planning interface
Information Exchange Flow
Figure 13 in Section 2.4.4.2 depicts the information exchange flow for the Long Term Planning interface.
Interface Functions
The interface performs the following functions:
- Creating an Event - introduces a new Event into the ASM Support System
- Updating an Event - updates an existing Event in the ASM Support System
- Requesting a List of Events - allows access to the Event information from within the ASM Support System
ASM-INTF-LTPL-010: ASMtoASM Service should be supported by the Long Term Planning interface to manage the events.
ASM-INTF-LTPL-020: The Long Term Planning interface shall support the following operations:
- createEvent,
- updateEvent,
- queryEventList.
Operations
This operation is intended to introduce a new Event into the ASM Support System.
Associated messages
ASM-INTF-LTPL-030: The createEvent operation shall receive and process the EventCreationRequest message from an External User.
ASM-INTF-LTPL-040: If the event request is valid, the createEvent operation shall transmit the newly created event in the EventReply message to the requesting External Users.
ASM-INTF-LTPL-050: If for any reason the request or the resulting event is not valid, the createEvent operation shall transmit an appropriate error in the EventReply message to the requesting External Users.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
This operation is intended to update an existing Event in the ASM Support System.
Associated messages
ASM-INTF-LTPL-060: The updateEvent operation shall receive and process the EventUpdateRequest message from an External Users.
ASM-INTF-LTPL-070: If the event update is valid, the updateEvent operation shall transmit the updated event in the EventReply message to the requesting External User.
ASM-INTF-LTPL-080: If for any reason the request or the resulting updated event is not valid, the updateEvent operation shall transmit an appropriate error in the EventReply message to the requesting External User.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
This operation is intended to allow access to the Event information from within the ASM Support System.
Associated messages
ASM-INTF-LTPL-090: The queryEventList operation shall receive and process the EventListRequest message from an External Users.
ASM-INTF-LTPL-100: If the event list request is valid, the queryEventList operation shall transmit the matching list of events in the EventListReply message to the requesting External User.
ASM-INTF-LTPL-110: If for any reason the request is not valid, the queryBookingList operation shall transmit an appropriate error in the EventListReply message to the requesting External Users.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
Endpoints
N/A