JSON API - SETRESASSIGNMENTS

Owned by Vincent Josset
Feb 20, 2023
1 min read

Assigns passengers to services on an existing reservation.

Input

  • Login: API user login

  • Password: API user password

  • TransType: SETRESASSIGNMENTS

  • ResNumber: The ResNumber of the reservation whose service assignments to update

  • Assignments: JSON array of assignment objects:

    • ServiceSeq: The ServiceSeq of the service whose assignments to update

    • RoomsAssigned: The string representing the assignment of service quantities to passengers (see format notes below)

Output

This new API method will either return an error message (if it failed), or the update Reservation object (same as GETRES and BOOK methods' output)

RoomsAssigned Format

RoomsAssigned is a string in a specific format that indicates which rooms/services are assigned to which passengers. This is a coded string that associates room/service numbers to passenger seq numbers.
If a service has a blank RoomsAssigned value, it is interpreted as being assigned to all passengers on the reservation.

RoomsAssigned is a slash-separated list of room/service numbers with their assigned PassengerSeq numbers. Each passenger in a reservation has a unique PassengerSeq number that will be part of the RoomsAssigned value for all assigned services.

Basic Format

[RoomNumber]:[PassengerSeq]-[PassengerSeq]/[RoomNumber]:[PassengerSeq]-[PassengerSeq]

Examples

  • One room assigned to the first two passengers on the reservation:

    1:1-2

  • Two rooms - First room assigned to passengers 1 and 3, second room assigned to passengers 2 and 4:

    1:1-3/2:2-4

Note that per-person services don't have "rooms". In those cases, the assignments are done with a "room number" of 1.
Example:
Two per-person transfers (service with qty 2) to be assigned to passengers 1 and 3:

1:1-3

 

Four fees (service with qty 4) to be assigned to passengers 2, 4, 5, and 9:

 

Example

Â