ARCOS API Functionality Matrix

Legend

Access # Bitmask	Access determines the operations available: 1 = Get, 2 = Put, 4 = Post, 8 = Delete, 16 = Patch. Access is a bitmask, so add the values together to provide access to multiple actions. For example, to allow GET and POST, you would use 5 = (1 + 4).
Extract endpoint	The extract methods are part of the basic API, but they require engineering and cloud OPS work to set up and maintain. They are also outdated and not aligned with the best practices of using API. The team suggests to phase out the extract methods and replace them with regular API endpoints
Inconsistency	A spot check of about a dozen production sites shows that the API endpoints are not configured consistently for either Basic or Enterprise customers
POST and GET limits	Seeking feedback from PS on what frequency should be set and what use case supports that frequency
Value of "X"	Indicates the that method is included

		Basic					Enterprise
Endpoints (in alpha order)	Endpoint Description	GET	POST	PUT	DELETE	Access #	GET	POST	PUT	DELETE	Access #
application/wadl	The WADL Endpoint provides REST data for the schema. Data includes the WADL documentation in XML format and the XML Schema Definition for ARCOS class objects.	x				1	x				1
auth	This endpoint is used to generate a token that is normally used by the middleware to authenticate transactions.	x	x			5	x	x			5
callout	The Callout endpoint can be used to manage ARCOS callouts and their properties. Users can get basic config information (attributes, cotypes, reasons, etc...) as well as creating new or updating existing callouts. The API also supports callout searches and managing callout result and call detail data.						X	X	X		7
classes	The Classes endpoint can be used to obtain the configured Classes for the system. Each Class that is returned will contain a list of locations that are configured to use the Class as well as an user defined XWalk values that may represent the Class in external systems. Classes may be defined as either a 'Primary Class' or a 'WorkGroup'.	X				1	X				1
cm	The Crew Manager Endpoint can be used to manage the data that is normally accessed using the Arcos Crew Manager Application. Users can create new instances of Crews, Resources, and Lodgings. The API also supports changing Attribute values and assigning Members to Crews. All Crew Manager operations require a Point In Time (PIT) value to orient the operation within Crew Manager. If no PIT value is provided by the user, the current server time will be used.						X	X	X	X	15
config	This endpoint retrieves lists of Scheduled Events or event traits.	X				1	X				1
employees	The Employee endpoint can be used to obtain and modify data that is normally access through the Employee tab in the ARCOS Web Application. Employee standard properties will be returned using a collection of Attribute elements. Each Attribute will contain a 'key' field that can be used to uniquely identify the Employee property that is represented by the Attribute. A listing of the Attribute keys and the properties they represent is below. Some of the keys may not be available, depending on	X	X	X	X	15	X	X	X	X	15
events	This endpoint can be used to get information on events and incidents.	X				1	X				1
extracts	The Extracts endpoint can be used to obtain a list of available extract reports for a customer. In addition, when provided with a specific extract file name it will decrypt and send that file to the client.	X				1	X				1
loader	The Loader Data Endpoint provides services to interact with the ARCOS file Loader. All existing loader file types are fully supported by the API.	X	X			5	X	X			5
locations	Locations in ARCOS allow users to maintain a 4-tiered hierarchical grouping of logical business units for their organization. Each Location may have its own configuration for things like Rosters, Classes, Callouts, Shifts, etc. The Locations at the top of this hierarchy are referred to as Level 1 locations, children of those are Level 2 locations, etc. Each Employee in the system is assigned to a specific Level 4 Location.	X				1	X				1
rosters	The Roster Endpoint can be used to search, create, delete, or update a roster list as presented on the List Maintenance page within the core Arcos application. This endpoint also supports Roster Push extract downloads.						X	X	X	X	15
schedules	An Employee's schedule within ARCOS consists of a collection of ScheduleRecords.These ScheduleRecords are created whenever an Employee is given a ScheduledShift or ScheduleException. ShiftAssignments essentially represent collections of ScheduledShift objects for an Employee for a given week. Once the ShiftAssignment is created for an Employee, the corresponding ScheduledShift records are automatically created by Arcos. For example, if a Shift is defined as Monday - Friday from 8:00 - 5:00pm, then creating a ShiftAssignment for an Employee for that Shift would create 5 SheduledShift records, one for each day represented in the Shift. Deleting a ShiftAssignment will remove its corresponding ScheduledShift records.						X	X	X	X	15
shifts	The Shift Endpoint allows the working shift information to be edited and retrieved.						X	X	X	X	15
smart	The sMART Endpoint can be used to manage the Active Vehicle Location (AVL) data that is normally accessed using the ARCOS sMART Application.						X				1
vox	Used to create a custom message via the API						X				5
xwalks	Maps a Company ID to an ARCOS ID. Usually for Locations, and Primary Classes, but here is the entire list:CLASS (Primary Class)EMP (Employee)EVENT (Schedule Status, like Working - Normal Shift)LIST_STATUSLOC (Location)SCHEDREC (Actual Schedule Record; Event + Start and Stop Times)SEC (Security Group )	X				1	X				1