Set Multiple "On Leave" Presence Entries

post

https://{subdomain}.maptician.com/ext/v1/presence/leave_dates

This endpoint is used to create one or more presence entries characterized by each data entry having a start and an end time. These times can take various formats, but should include date and time components, with both start and end being required for the creation of an entry.

These entries are intended to allow for the time bounded presence entries resulting from entrance and exit controlled systems or other detailed presence tracking methods.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

onInvalid

string

enum

Defaults to cancel

This determines what happens when a data entry's contents are found to be invalid and unable to result in a successful entry. Options are either to cancel the entire operation with no entries being created, or to skip the invalid ones and create all possible entries with the data provided.

Allowed:

onConflict

string

enum

Defaults to cancel

This determines what happens when a submitted data entry conflicts with an existing record in the Maptician environment. This is usually the result of a specific Occupant already having a set presence status for a period of time covered by a submitted record. Options are to skip the submitted conflicting entry and to continue to create all valid presence entries, or to cancel the entire operation without any entries being created.

Allowed:

unmatchedAction

string

enum

Defaults to cancel

This determines what happens when a data entry is unable to be matched with either an Occupant or a Location. Options are either to cancel the entire operation with no entries being created, or to skip the invalid ones and create all possible entries with the data provided.

Allowed:

occupantMatchType

string

enum

Defaults to email

This is the method that the server will use to try to find a match for an Occupant. Options are email, employeeID, and userID.

Email is case insensitive but otherwise must match exactly what is found in the Occupant's profile in Maptician. If email is used, each data entry must have a field labeled 'email' which contains the email value.
Employee ID is case sensitive and must match exactly the Employee ID field in an Occupant's Maptician profile. If Employee ID is used, each data entry must have a field labeled 'employeeID' which contains the data value.
User ID is a unique identifier used by Maptician to identify each Occupant record - it is usually obtained through an API endpoint. If User ID is used, each data entry must contain a field labeled 'userID' which contains the unique identifier.

Allowed:

dateFormatType

string

enum

Defaults to iso

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

iso - ISO 8601 formatted, such as YYYY-MM-DD or "2021-05-31"
unixS - UNIX Timestamp in seconds
unixMS - UNIX Timestamp in milliseconds
us - US formatted MM-DD-YYYY or "05-30-2021"
international - International formatted DD-MM-YYYY or "30-05-2021"
longForm - Long date form MMMM D, YYYY or May 30, 2021

Allowed:

data

array of objects

required

An array of leave date presence entries where each entry represents a date range for an Occupant indicating dates during which they will be on leave or otherwise not working.

data*

Headers

mapticianauth

string

required

Authorization token to access the API.

Responses

500

Server Error

200Response returned when the bulk presence upload process was completed. This means that all entries were either completed successfully, or skipped.

400Response returned when the bulk presence upload process cancelled due to known defects or conflicts with the environment data or uploaded data. If this response is received, no actions were taken.