Mark Present and Reserve Owned Seat

The endpoint is intended to be used in conjunction with a "restricted reservable" or "owned reservable" hotel seating strategy. It requires a user to be identified in the body, and optionally a date or time parameter. If the user provided has a reservable seat where they are specifically marked as a permitted reserver, they will be booked for that seat for the day (or rest of the day) if that seat is available. If they do not have a permitted seat, the API will respond with a 202 status code. If no date is provided, or if the date is the current date, then the users will be marked as present at the location of the permitted seat for the current day. If the seat was already reserved and a reservation wasn't created, the user will still be marked as present at that location.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The only required parameter for this endpoint is a user identifier, which may take the form of one of the following (which is also the order of precidence if multiple identifiers are provided)

  1. User ID - An internal Maptician userID value for the target user.
  2. Email Address - A case insensitive email address value which must match the email for the user within Maptician.
  3. Employee ID - A case sensitive string representing the employee's employee ID as entered within Maptician.
  4. External ID - Not common, but Maptician users may be mapped to external systems using an external ID value.
  5. Employee Name - Least preferred due to risk of ambiguity and alternative spellings, a first and last or name parameter may be used to search for a user based on their name within Maptician.

If no time value is provided, the current time will be used based on when the request was received. A time parameter can be provided, in addition to a date parser format which will be used to attempt to parse the provided date value (default is ISO_8601). By default, the time of the presence status and reservation will start from the provided time / current time, but optionally, a "full day" parameter can be passed to attempt to use the full calendar day values for start and end.

uuid

The unique identifier that Maptician assigns to each Occupant and User. This can be obtained through Maptician's API. This is the highest priority item in identifying a target for the presence operation.

string

The email (case insensitive) of the Occupant or User subject to the presence operation. This must match their email within the Maptician environment. This is the second highest priority in identifying an individual.

string

A string representing the individual's employee ID or other organization specific identifier. This values must match (case sensitive) the value of Employee ID in the Maptician environment for this individual. This is the the third highest priority for identifying an individual.

string

A string representing an identifier set by the SCIM provisioner or otherwise set within Maptician to represent a specific individual. This is an infrequently used method and will not be applicable to most environments. This has the fourth highest priority for identifying an individual.

string

A string representing the concatenated first and last name of the individual. These values must match the first and last names found within Maptician (case insensitive). There is a potential for multiple matching users being found - the action will apply to the first matched individual only. This method is not recommended due to this potential ambiguity if any other matching mode is possible.

string

The first/given name of an individual. Must be used in conjunction with 'last' and will result in the same outcome as using the concatenated value in 'name'

string

The last/family name of an individual. Must be used in conjunction with 'first' and will result in the same outcome as using the concatenated value in 'name'

string
enum
Defaults to iso

This is the method the server will use to attempt to parse the start and/or end times in each data entry. All date/time values must use the same format. The options are as follows

  • iso - ISO 8601 formatted, such as YYYY-MM-DDTHH:mm:ss:SSSZZ or "2021-05-31T03:32:15.064Z"
  • unixS - UNIX Timestamp in seconds
  • unixMS - UNIX Timestamp in milliseconds
  • us - US formatted MM-DD-YYYY hh:mm a Z or "05-30-2021 11:39 PM -04:00"
  • international - International formatted DD-MM-YYYY HH:mm Z or "30-05-2021 23:39 -04:00"
  • longForm - Long date form MMMM D, YYYY HH:mm Z or May 30, 2021 23:39 -04:00

Allowed:
string

This is the time that will be used as a start time for presence and the reservation. The end time will be the end of the day for this time, based on the timezone of the user's seat location. If the full_day parameter is true, then the date component of the time will only be used and the start will be the start of that date.

boolean

Determines whether the presence entry and reservation should be from the provided/current time to the end of the day (false or omitted), or the start of the day to the end of the day (true).

Headers
string
required

Authorization token to access the API.

Responses
200

Request Successful

500

Server Error

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json