The consuming application can use the position XRefCodes it has retrieved using the Get Position XRefCodes request to retrieve further information about positions using a series of Get Position Detail by XRefCode requests.
The consuming application will need to make one request for each XRefCode. The XRefCode is added to the base URL as shown here:
https://www.dayforcehcm.com/api/CompanyName/V1/Positions/[XRefCode]
The full position history isn’t included in the response. Instead, the consuming application can use the ContextDate parameter to request data as of a specified point in time. See the ContextDate parameter description below for more information.
Parameters
Consumers can retrieve position details by using combinations of the following common query parameters:
ContextDate (datetime)
- The
ContextDatevalue is always used as an as-of date in determining which position data to return. - The service defaults to the current datetime if the requester doesn't specify a value.
- The datetime value should be expressed as
yyyy-mm-ddThh:mm:sswhereTis a separator used between the date and time; for example,2017-01-01T13:24:56. - The URL syntax is: https://www.dayforcehcm.com/api/[CompanyName]/V1/Positions/[XRefCode]?ContextDate=20170201T14:59:59
Expand (string)
- Dayforce recommends optimizing requests for position details so that only the details from the required position assignments are included in the results.
- The following is an example of the URL syntax:
https://www.dayforcehcm.com/api/[CompanyName]/V1/Positions/[XRefCode]?ContextDate=20170201T14:59:59&expand=PositionAssignments
Response
The response of the RESTful Get Position Detail by XRefCode request is returned in a JSON format. You can see an example of the response on the Dayforce Developer Network.
Security
To retrieve position data, the web service user's primary role must have the HCM Anywhere > Web Services > Read Data checkbox selected in the Features tab of System Admin > Roles.