Labor Management API

Labor Management provides SOAP and REST APIs for retrieving information over HTTP or HTTPS connections. The API supports the following transfer protocols to handle different types of data:

• Simple Object Access Protocol (SOAP)
• Representational State Transfer (REST)
• Authentication and Authorization

SOAP

You can use the SOAP APIs to modify and retrieve employee data through methods that:

• Retrieve employee details by name, external payroll ID, and payroll ID
• Retrieve portal user details (POS roles)
• Create new employees and portal users
• Modify the information of existing employees and portal users
• Transfer employees from one home store to another
• Assign employees to an away store
• Terminate employees
• Place employees on leave of absence (rehire employees)
• Change employee pay rates
• Create time cards for employees
• Retrieve employee time card details
• Retrieve labor details for a location
• Retrieve location details
• Retrieve job code and job category details
• Assign magnetic card numbers for home stores

REST

You can use the REST API to access Reporting and Analytics advanced modules from mobile devices and tablets through methods that:

• Retrieve all employee details for a location
• Retrieve details for one employee
• Retrieve all locations for an organization
• Retrieve information for one location
• Retrieve all time card punches for a location
• Retrieve information for all versions of a REST API
• Retrieve information for a specific API version
• Authenticate and authorize

Authentication and Authorization

SOAP endpoints (http://ServerName/labor/labor?wsdl) and REST endpoints use an API token and password to authenticate client requests. These credentials are generated by creating an API user in the Reporting and Analytics portal. See Create API Users in the Oracle MICROS Labor Management RESTful API and Supporting Interfaces Guide.

For SOAP API calls, include the token and password in the SOAP header as a Username Token parameter in WS-Security. For REST API calls, include the token and password in the HTTP request header. See Authentication and Authorization in the Oracle MICROS Labor Management API Programmer's Guide.

All endpoints support HTTPS, ensuring secure communication channels. Clients consuming these APIs are responsible for securely storing authentication credentials.