{"info":{"_postman_id":"9455541d-0ac5-245d-9daa-ed3dc6fc7323","name":"Cezanne HR API","description":"

The Cezanne HR API (Application Programming Interface) has been created to allow integration with other products and services, along with enabling clients and third parties to integrate data with their own internal applications or create new ones.

How has the API been developed?

\n\n

The API has been developed based on the Open Data Protocol (oData), which is built on web technologies such as HTTP and popular methodologies such as REST (Representational State Transfer). The API can return data either in XML (Extensible Markup Language) or JSON (JavaScript Object Notation).

Access to the API can also be restricted to specific users, with access to data matching the main application. For example, if Joe Bloggs can only see people in the UK through the main application, the same restrictions will apply when using an application via the API.

Authentication

\n\n

The Cezanne API uses the oAuth 2.0 protocol to manage authentication and authorisation.

As HR data can be confidential, the API is secured and you must request an access token before being able to retrieve and / or modify any data.

1. Generate the Client ID and Client Secret within Cezanne.

Navigate to: Administration >> Security Settings >> Authorised Applications
\n
Add a new API application and choose the scopes you require. For more information, see: Add / Enable API Access (Generate Client ID and Secret).
\n

2. Generate an Access Token from the Cezanne Authorisation Server.
- In order to access data, you must request an access token. A single access token can be granted different scopes to access the API. A scope controls the set of resources and operations that an access token permits. During the access-token request, your application sends one or more values in the scope parameter.
- Using the application details, you can request an access token using a browser redirect. The request requires an
authentication step where the user logs in with their Cezanne HR credentials.
- After logging in, the user is asked whether they are willing to grant the permissions that your application is requesting.
- If the user grants permission, the authorisation server sends your application an access token (or
an authorisation code that can be used to obtain an access token).
- If the user does not grant the permission, the server returns an error.

\n\n

3. Use the Token to access Cezanne APIs.
- Once you have generated the access token, you should send it to the API in an HTTP authorisation header.
- An access token can only be used for the scope of the application. E.g. If an access token is issued read-only permission, you cannot insert / update data against an API.
- Access tokens can be used multiple times for operations requiring the same level of permissions.

\n\n

4. Refresh the token if necessary.
- Access tokens have limited lifespans. If your application needs access to an API beyond the expiry of a single access token, it can obtain a refresh token.
- A refresh token allows your application to obtain new access tokens.
- Refresh tokens should be saved in secure long-term storage as they generally remain valid for long periods of time.

\n\n

Generate Token Using Client ID and Secret

\n\n

If you are building an app which simply queries or writes to the API with no additional user authorisation required, you should use an encoded Client ID and Secret to generate an access token.

The Token can be generated by running a POST request to the Token Endpoint:

Token Endpoint

\n\n

https://w3.cezanneondemand.com/CezanneOnDemand/OAuth/Token\n\n

The request should include a Basic Authorisation header with the encoded Client ID and Secret and it should include the following parameters in the body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value(s)	Description
grant_type	client_credentials	As you are just using Id and Secret, this should be set to client_credentials.
scope	should be set to the scope value that the support team has set up for you	http://www.cezannehr.com/auth-scope/APIRead http://www.cezannehr.com/auth-scope/APIWrite

The actual request might look like:

POST https://w3.cezanneondemand.com/CezanneOnDemand/OAuth/Token HTTP/1.2\nContent-Type: application/x-www-form-urlencoded\nHost: w3.cezanneondemand.com\nAuthorization: Basic [ENCODED_CREDENTIALS]\ngrant_type=client_credentials&\nscope=http://www.cezannehr.com/auth-scope/APIRead\n\n

Using Authorisation Process Flow

\n\n

If you are building an app which requires user's to authorise their scope (e.g. Mobile Application, SSO Application), you should use the Authorisation Process Flow described below:

\n\n

The authorisation process begins by redirecting a browser (popup, or full page if needed) to the Authorisation Endpoint with a set of query parameters that indicate the type of access the application requires (scopes).
\n
The user logs in and grants permission, this results in an authorisation code.
\n
The caller receives the authorisation code in the query string.
\n
After receiving the authorisation code, the application can exchange the code for an access token and a refresh token.
\n
The application presents its Client ID and Client Secret (obtained during application registration) along with the authorisation code to obtain an access token and refresh token.
\n
Once the application receives an access token, it can then access the API. If a refresh token is present in the
authorisation code exchange, then it may be used to obtain new access tokens at any time.
\n

Authorisation Request

\n\n

The authorisation request is performed by invoking the Cezanne HR authorisation endpoint.

The endpoint is accessible over SSL only.

Authorisation Endpoint

\n\n

https://w3.cezanneondemand.com/CezanneOnDemand/OAuth/Authorize\n\n

This endpoint manages the authorisation process, authenticating the user and handling user consent.

The query string parameters supported by Cezanne are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value(s)	Description
response_type	code	Determines if the Cezanne OAuth 2.0 endpoint returns an authorisation code.
client_id	The client_id value sent from the Support team when registering your application.	Indicates the client application performing the request. This value is case sensitive.
redirect_uri*	One of the redirect_uri values registered for the application by the Support team.	The address that the response is sent to by the authorisation server. This value is case sensitive and must match the configured one, including the trailing '/'.
scope	A space delimited string representing the permissions requested by the application.	The permissions used to access the API. THe user has to grant the application permission to use the requested set of permissions in the user consent page.
auto_approve**	A boolean value: It can be 'true' or 'false' (without quotes)	This is an optional parameter which is defined by the Support team when registering your application.
state	Any string value.	A string that is sent to the server representing the state of the application. This string is then returned in the response. Usage of this parameter can be preventing cross-site-request forgery or preserving some application state. This parameter is not mandatory and can be omitted.

*Redirect URI

When you ask the Support team to register an application, you will need to specify your redirect URIs. They are used to return the authorisation code to your application.

\n\n

The authorisation code is always returned as a query string parameter on the client. To receive the
authorisation code on this URL, your application must be listening on the local web server.

\n\n

For your application you can use:

\n\n

x-cez://oauth-callback/

\n\n

When this value is used, your application may intercept the navigating event of the browser control,
disable the current navigation and get the authentication code available on the query string.

\n\n

**Auto Approve

The auto_approve parameter is an optional parameter which is configured when the application is registered by the Support team.

The available options for the “Auto approve mode” are:

Disabled - The authorisation page is always displayed to the final user and the auto_approve parameter is ignored.
\n
Automatic - The authorisation page is displayed only the first time the user authorises the application and
the auto_approve parameter is ignored.
\n
OnDemand - The authorisation page is displayed at least the first time the user authorises the application. For subsequent authorisations the auto_approve parameter specifies whether the authorisation page should be displayed. By default the auto_approve parameter is false.
\n

Authorisation Request Example

\n\n

https://w3.cezanneondemand.com/CezanneOnDemand/OAuth/Authorize?\nclient_id=[Your Client ID]&scope=http://www.cezannehr.com/auth-scope/APIRead http://www.cezannehr.com/auth-scope/APIWrite&redirect_uri=x-cez://oauthcallback/&response_type=code\n\n

Authorisation Response and Token Exchange

\n\n

After the application receives the authorisation code, it may exchange it for an access token and a refresh token. This request is an HTTP post to the token endpoint.

The endpoint is accessible over SSL only.

Token Endpoint

\n\n

https://w3.cezanneondemand.com/CezanneOnDemand/OAuth/Token\n\n

The request can include the following parameters in the body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value(s)	Description
client_id	The client_id value sent from the Support team when registering your application.	Indicates the client application performing the request. This value is case sensitive.
client_secret	The client_secret value sent from the Support team when registering your application.	A secret for the client ID. Given the nature of the installed applications flow, the client secret cannot be considered confidential.
redirect_uri	One of the redirect_uri values registered for the application by the Support team.	The address that the response is sent to by the authorisation server. This value is case sensitive and must match the configured one, including the trailing '/'.
grant_type	authorization_code	As defined in the OAuth 2.0 specification, this field must contain a value of authorization_code.
code	A string value.	The authorisation code returned from the initial request.

The actual request might look like:

POST https://w3.cezanneondemand.com/CezanneOnDemand/OAuth/Token HTTP/1.2\nContent-Type: application/x-www-form-urlencoded\nHost: w3.cezanneondemand.com\nclient_id=[Your Client ID]&\nclient_secret=[Your Client Secret]&\nredirect_uri=x-cez://oauth-callback/&\ngrant_type=authorization_code&\ncode=[Your Authorisation Code (from previous response)]\n\n

A successful response to this request contains the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value(s)	Description
access_token	A string.	The access token.
token_type	bearer	The token type. This value is used when invoking an API (see next section).
scope	A space delimited string representing the permissions granted by the user.	The scope string, as specified in the request.
expires_in	An integer value.	The number of seconds the access token is valid. This value can be used to understand in advance that the access token is expiring and refresh the token to get a new one.
refresh_token	A string.	A token that may be used to obtain a new access token, and are included by default for installed applications. Refresh tokens are valid until the user revokes access.

A successful response is returned as a JSON array, similar to the following:

{\n \"access_token\": \"[Your Generated Token]\",\n \"token_type\":\"bearer\",\n \"expires_in\":600,\n \"refresh_token\":\"[Your Refresh Token]\",\n}\n\n

Notes:

Other fields may be included in the response. Your application should allow additional fields to be returned in the response. The set shown above is the minimum set.
\n
The actual values of code, access_token and refresh_token parameters have been
truncated for readability; real codes are quite longer.
\n

Using a Refresh Token

\n\n

Requesting a new access token is simple. To request a new access token, make HTTPs POST to the token endpoint.

Token Endpoint

\n\n

https://w3.cezanneondemand.com/CezanneOnDemand/OAuth/Token\n\n

These requests must include the following parameters in the body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value(s)	Description
client_id	The client_id value sent from the Support team when registering your application.	Indicates the client application performing the request. This value is case sensitive.
client_secret	The client_secret value sent from the Support team when registering your application.	A secret for the client ID. Given the nature of the installed applications flow, the client secret cannot be considered confidential.
refresh_token	A string value.	The refresh token returned from the authorisation code exchange.
grant_type	refresh_token	As defined in the OAuth 2.0 specification, this field must contain a value of refresh_token.

Such a request will look similar to the following:

POST https://w3.cezanneondemand.com/CezanneOnDemand/OAuth/Token HTTP/1.2\nContent-Type: application/x-www-form-urlencoded\nHost: w3.cezanneondemand.com\nclient_id=[Your Client ID]&\nclient_secret=[Your Client Secret]&\ngrant_type=refresh_token&\nrefresh_token=[Your Refresh Token]\n\n

As long as the user has not revoked the access granted to your application, the response includes a new access token. A response from such a request is shown below:

{\n \"access_token\":\"[Your Generated Token]\",\n \"token_type\":\"bearer\",\n \"expires_in\":600,\n \"refresh_token\":\"[Your Refresh Token]\",\n}\n\n

Notes:

Other fields may be included in the response. Your application should allow additional fields to be returned in the response. The set shown above is the minimum set.
\n
You should save refresh tokens in long-term storage and continue to use them as long as they remain valid.
\n

Invoking Cezanne APIs

\n\n

Once your application has obtained an access token, your application can access a Cezanne API by including it in either an access_token query parameter or an Authorization: Bearer HTTP header.

For example, a call to the OData API using the Authorization header looks like the following:

GET https://w3.cezanneondemand.com/CezanneOnDemand/DataService.svc/People?$format=json\nHTTP/1.1\nAuthorization: Bearer\n[Your Generated Token]\nHost: w3.cezanneondemand.com\n\n

Using the flow for Single Sign-On (SS0)

\n\n

The previous authentication examples are typical use cases of OAuth2 that allow you to invoke Cezanne APIs to access data like reports, photos or update data.

We have a further specific API named TokenInfo which can be used to identify users and link them to previously registered accounts without having to manage their identities. The Tokeninfo endpoint provides base information related to the logged in user like first name, last name, e-mail address and the UserGuid which uniquely identifies the account.

An example of using this could be setting up users in your application in advance and assigning privileges in that application. Then you can create a relationship between the user in your application and the Cezanne user account using the UserGuid. This means that a user who has already logged in to Cezanne, the application invoking the TokenInfo endpoint can discover the user identity and grant them the required access to your application.

For example, a call to the TokenInfo API using the Authorization header looks like the following:

GET https://w3.cezanneondemand.com/CezanneOnDemand/OAuth/TokenInfo\nHTTP/1.1\nAuthorization: Bearer [Your Generated Token]\nHost: w3.cezanneondemand.com\n\n

This will provide a json result that includes the following information:

{\n    \"PersonGuid\" : \"7ab6ef7a-43cd-472f-852a-bbee3992ad19\",\n    \"TenantGuid\" : \"00000000-0000-0000-0000-000000000000\",\n    \"RoleGuid\" : \"00000000-0000-0000-0000-000000000111\",\n    \"UserGuid\" : \"85feff6b-4d94-47c3-b429-6713ac346196\",\n    \"Username\" : \"hrprof@cezannesw.com\",\n    \"CountryId\" : 1,\n    \"CountryName\" : \"United Kingdom\",\n    \"EmailAddress\" : \"hrprof@cezannesw.com\",\n    \"FirstName\" : \"HR Professional\",\n    \"FormattedName\" : \"Cheryl Abrahams\",\n    \"LastName\" : \"HR Professional\",\n    \"LocaleId\" : 2057,\n    \"LocaleName\" : \"en-GB\",\n    \"RoleHierarchy\" : [\"00000000-0000-0000-0000-000000000111\"],\n    \"TimeZone\" : \"Greenwich Standard Time\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
PersonGuid	The unique identifier of the people record in Cezanne linked to the user (if an internal user).
TenantGuid	The unique identifier of the tenant (Organisation).
RoleGuid	The identifier of the user role in Cezanne.
UserGuid	The unique identifier of the user account in Cezanne.
Username	The identifier of the user in Cezanne.
CountryId	The Country Code of the user.
CountryName	The Country Name of the user.
FirstName	The first name of the person associated to the user account.
FormattedName	The full name of the person associated to the user account.
LastName	The last name of the person associated to the user account.
LocaleId	The Locale Code of the user.
LocaleName	The Locale Name of the user.
RoleHierarchy	The identifier of the base user role for the user role.
TimeZone	The Time Zone of the user in Cezanne.

Webhooks

\n\n

Webhooks in Cezanne allow you to integrate key information with other platforms in real time. When an event happens in Cezanne (e.g. a change to an Address record), a webhook will automatically notify the connected platform (sometimes known as an endpoint). Events include adding new records, editing records, and deleting records. These events are split into categories based on the record type and are known as triggers in the system.

To use webhooks, you must set up a webhook for each platform or endpoint and activate it by enabling specific triggers which will set the webhook off.

For more information, see:

Webhooks

Google Calendar Sample

\n\n

We have developed a sample application using v2 of the API which can extract all employee Absences, based on a configured list of Absence Types and Companies and import them into a Google Calendar. This can then be shared within your organisation providing an overall picture of all absences.

\n\n

To download the sample code, click here.

To download the sample application, click here.

Power Query

\n\n

You can use the Power Query Excel add-on to access the Cezanne API and produce reports using multiple queries.

\n\n

For more information about setting this up, see:

Setting Up Power Query

Response Codes

\n\n

When using the API, the following list of response codes will be returned:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description
200 OK	A request that does not create a resource returns 200 OK if it is completed successfully and the value of the resource is not null. In this case, the response body MUST contain the value of the resource specified in the request URL.
201 Created	The request has been fulfilled and resulted in a new resource being created.
202 Accepted	The request has been accepted for processing, but the processing has not been completed. The request may or may not eventually be acted upon, as it may be disallowed when processing actually takes place.
204 No Content	The server successfully processed the request, but is not returning any content. This is the most likely response to a successful delete request.
401 Unauthorised	Authentication has failed or not been provided. Your token may have expired or you may have not yet generated a token.
404 Not Found	The requested resource could not be found
405 Method Not Allowed	The request cannot be used for this record
500 Internal Server Error	A generic error message used when there is no other specific message. The most likely scenarios for this message is that you are trying to retrieve / delete a record that doesn't exist or you are trying to insert data that is not supported in a particular field.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Invoking Cezanne APIs","slug":"invoking-cezanne-apis"},{"content":"Using the flow for Single Sign-On (SS0)","slug":"using-the-flow-for-single-sign-on-ss0"},{"content":"Webhooks","slug":"webhooks"},{"content":"Google Calendar Sample","slug":"google-calendar-sample"},{"content":"Power Query","slug":"power-query"},{"content":"Response Codes","slug":"response-codes"}],"owner":"2420781","collectionId":"9455541d-0ac5-245d-9daa-ed3dc6fc7323","publishedId":"6fbRhCt","public":true,"customColor":{"top-bar":"0083D3","right-sidebar":"303030","highlight":"0083D3"},"publishDate":"2026-01-12T10:15:31.000Z"},"item":[{"name":"Table Based APIs","item":[{"name":"Employee Record","item":[{"name":"Personal Information","item":[{"name":"People","item":[{"name":"List of Employees","id":"d39287c3-aad6-7501-e169-e7c512966cb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"tokenName":"","clientSecret":"{{client_secret}}","clientId":"{{client_id}}","scope":"","challengeAlgorithm":"","grant_type":"","client_authentication":"","accessTokenUrl":"","accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/People?$format=json","description":"

This request will return a list of people in the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["People"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"65bb8fae-7601-6503-e743-0abd6c68c8fd","name":"Return Active Employees","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{url}}/People?$filter=ActiveEmployee eq 1","host":["{{url}}"],"path":["People"],"query":[{"key":"$filter","value":"ActiveEmployee eq 1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1833","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Tue, 18 Jul 2017 17:16:41 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"623","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#People\",\n \"value\": [\n {\n \"PersonGUID\": \"db162c7c-7526-40a1-a4a3-ebbb5043a6fe\",\n \"PersonCode\": \"0590\",\n \"FamilyName\": \"Edwards\",\n \"FirstName\": \"Lawrence\",\n \"Salutation\": null,\n \"Gender\": \"Male\",\n \"ActiveEmployee\": 1,\n \"DateOfBirth\": \"1973-08-08T00:00:00\",\n \"AdditionalFamilyNames\": \"\",\n \"FamilyNamePrefix\": null,\n \"FullName\": \"Lawrence Edwards\",\n \"LegalName\": \"Lawrence Edwards\",\n \"KnownAs\": \"Larry\",\n \"SuffixTitle\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"CountryOfResidence\": null,\n \"AgeMonths\": 11,\n \"AgeYears\": 43,\n \"CityOfBirth\": null,\n \"Comments\": null,\n \"EthnicOrigin\": null,\n \"MiddleName\": null,\n \"MilitaryStatus\": null,\n \"Nationality\": \"French\",\n \"PrimaryLanguage\": null,\n \"Race\": null,\n \"Picture\": null,\n \"TobaccoUser\": 0,\n \"DeceasedDate\": null,\n \"Deceased\": 0,\n \"Student\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:48:25.757Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"PersonPronouns\": \"he/him\",\n \"BirthMonth\": \"August\",\n \"BirthYear\": 1973,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n },\n {\n \"PersonGUID\": \"e5f1b2e7-d6ed-4f2b-9ed8-8c58a3824b74\",\n \"PersonCode\": \"0593\",\n \"FamilyName\": \"Waterhouse\",\n \"FirstName\": \"Laura\",\n \"Salutation\": null,\n \"Gender\": \"Female\",\n \"ActiveEmployee\": 1,\n \"DateOfBirth\": \"1968-04-11T00:00:00\",\n \"AdditionalFamilyNames\": \"\",\n \"FamilyNamePrefix\": null,\n \"FullName\": \"Laura Waterhouse\",\n \"LegalName\": \"Laura Waterhouse\",\n \"KnownAs\": \"Laura\",\n \"SuffixTitle\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"CountryOfResidence\": null,\n \"AgeMonths\": 3,\n \"AgeYears\": 49,\n \"CityOfBirth\": null,\n \"Comments\": null,\n \"EthnicOrigin\": null,\n \"MiddleName\": null,\n \"MilitaryStatus\": null,\n \"Nationality\": \"British\",\n \"PrimaryLanguage\": null,\n \"Race\": null,\n \"Picture\": null,\n \"TobaccoUser\": 0,\n \"DeceasedDate\": null,\n \"Deceased\": 0,\n \"Student\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:46:28.407Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"PersonPronouns\": \"she/her\",\n \"BirthMonth\": \"April\",\n \"BirthYear\": 1968,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n }\n ]\n}"},{"id":"9fc5765b-425b-e20a-f86b-4f15a7426243","name":"Return Top 5 People","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{url}}/People?$top=5","host":["{{url}}"],"path":["People"],"query":[{"key":"$top","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"4364","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Tue, 18 Jul 2017 17:18:35 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"755","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#People\",\n \"value\": [\n {\n \"PersonGUID\": \"db162c7c-7526-40a1-a4a3-ebbb5043a6fe\",\n \"PersonCode\": \"0590\",\n \"FamilyName\": \"Edwards\",\n \"FirstName\": \"Lawrence\",\n \"Salutation\": null,\n \"Gender\": \"Male\",\n \"ActiveEmployee\": 1,\n \"DateOfBirth\": \"1973-08-08T00:00:00\",\n \"AdditionalFamilyNames\": \"\",\n \"FamilyNamePrefix\": null,\n \"FullName\": \"Lawrence Edwards\",\n \"LegalName\": \"Lawrence Edwards\",\n \"KnownAs\": \"Larry\",\n \"SuffixTitle\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"CountryOfResidence\": null,\n \"AgeMonths\": 11,\n \"AgeYears\": 43,\n \"CityOfBirth\": null,\n \"Comments\": null,\n \"EthnicOrigin\": null,\n \"MiddleName\": null,\n \"MilitaryStatus\": null,\n \"Nationality\": \"French\",\n \"PrimaryLanguage\": null,\n \"Race\": null,\n \"Picture\": null,\n \"TobaccoUser\": 0,\n \"DeceasedDate\": null,\n \"Deceased\": 0,\n \"Student\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:48:25.757Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"PersonPronouns\": \"he/him\",\n \"BirthMonth\": \"August\",\n \"BirthYear\": 1973,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n },\n {\n \"PersonGUID\": \"e5f1b2e7-d6ed-4f2b-9ed8-8c58a3824b74\",\n \"PersonCode\": \"0593\",\n \"FamilyName\": \"Waterhouse\",\n \"FirstName\": \"Laura\",\n \"Salutation\": null,\n \"Gender\": \"Female\",\n \"ActiveEmployee\": 1,\n \"DateOfBirth\": \"1968-04-11T00:00:00\",\n \"AdditionalFamilyNames\": \"\",\n \"FamilyNamePrefix\": null,\n \"FullName\": \"Laura Waterhouse\",\n \"LegalName\": \"Laura Waterhouse\",\n \"KnownAs\": \"Laura\",\n \"SuffixTitle\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"CountryOfResidence\": null,\n \"AgeMonths\": 3,\n \"AgeYears\": 49,\n \"CityOfBirth\": null,\n \"Comments\": null,\n \"EthnicOrigin\": null,\n \"MiddleName\": null,\n \"MilitaryStatus\": null,\n \"Nationality\": \"British\",\n \"PrimaryLanguage\": null,\n \"Race\": null,\n \"Picture\": null,\n \"TobaccoUser\": 0,\n \"DeceasedDate\": null,\n \"Deceased\": 0,\n \"Student\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:46:28.407Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"PersonPronouns\": \"she/her\",\n \"BirthMonth\": \"April\",\n \"BirthYear\": 1968,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n },\n {\n \"PersonGUID\": \"c5c7176a-0901-4621-84a5-49e1f9048cfa\",\n \"PersonCode\": \"098907\",\n \"FamilyName\": \"Middleton\",\n \"FirstName\": \"Joan\",\n \"Salutation\": null,\n \"Gender\": \"Female\",\n \"ActiveEmployee\": 1,\n \"DateOfBirth\": \"1964-09-07T00:00:00\",\n \"AdditionalFamilyNames\": \"\",\n \"FamilyNamePrefix\": null,\n \"FullName\": \"Joan Middleton\",\n \"LegalName\": \"Joan Middleton\",\n \"KnownAs\": \"Joan\",\n \"SuffixTitle\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"CountryOfResidence\": null,\n \"AgeMonths\": 10,\n \"AgeYears\": 52,\n \"CityOfBirth\": null,\n \"Comments\": null,\n \"EthnicOrigin\": null,\n \"MiddleName\": null,\n \"MilitaryStatus\": null,\n \"Nationality\": \"British\",\n \"PrimaryLanguage\": null,\n \"Race\": null,\n \"Picture\": null,\n \"TobaccoUser\": 0,\n \"DeceasedDate\": null,\n \"Deceased\": 0,\n \"Student\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:45:28.48Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"PersonPronouns\": \"they/them\",\n \"BirthMonth\": \"September\",\n \"BirthYear\": 1964,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n },\n {\n \"PersonGUID\": \"285942c1-c5fc-4125-a466-b8471cbec638\",\n \"PersonCode\": \"100\",\n \"FamilyName\": \"Benson\",\n \"FirstName\": \"Harold\",\n \"Salutation\": null,\n \"Gender\": \"Male\",\n \"ActiveEmployee\": 1,\n \"DateOfBirth\": \"1955-11-17T00:00:00\",\n \"AdditionalFamilyNames\": \"\",\n \"FamilyNamePrefix\": null,\n \"FullName\": \"Harold Benson\",\n \"LegalName\": \"Harold Benson\",\n \"KnownAs\": \"Howard\",\n \"SuffixTitle\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"CountryOfResidence\": null,\n \"AgeMonths\": 8,\n \"AgeYears\": 61,\n \"CityOfBirth\": null,\n \"Comments\": null,\n \"EthnicOrigin\": null,\n \"MiddleName\": null,\n \"MilitaryStatus\": null,\n \"Nationality\": \"British\",\n \"PrimaryLanguage\": null,\n \"Race\": null,\n \"Picture\": null,\n \"TobaccoUser\": 0,\n \"DeceasedDate\": null,\n \"Deceased\": 0,\n \"Student\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2016-02-01T15:30:28.593Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"PersonPronouns\": \"he/him\",\n \"BirthMonth\": \"November\",\n \"BirthYear\": 1955,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n },\n {\n \"PersonGUID\": \"fb7146b5-86cb-4a28-9e7e-787433080aed\",\n \"PersonCode\": \"101\",\n \"FamilyName\": \"Brown\",\n \"FirstName\": \"Heather\",\n \"Salutation\": null,\n \"Gender\": \"Female\",\n \"ActiveEmployee\": 1,\n \"DateOfBirth\": \"1968-11-11T00:00:00\",\n \"AdditionalFamilyNames\": \"\",\n \"FamilyNamePrefix\": null,\n \"FullName\": \"Heather Brown\",\n \"LegalName\": \"Heather Brown\",\n \"KnownAs\": \"Heather\",\n \"SuffixTitle\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"CountryOfResidence\": null,\n \"AgeMonths\": 8,\n \"AgeYears\": 48,\n \"CityOfBirth\": null,\n \"Comments\": null,\n \"EthnicOrigin\": null,\n \"MiddleName\": null,\n \"MilitaryStatus\": null,\n \"Nationality\": \"German\",\n \"PrimaryLanguage\": null,\n \"Race\": null,\n \"Picture\": null,\n \"TobaccoUser\": 0,\n \"DeceasedDate\": null,\n \"Deceased\": 0,\n \"Student\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2016-02-01T15:30:36.297Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"PersonPronouns\": \"they/them\",\n \"BirthMonth\": \"November\",\n \"BirthYear\": 1968,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n }\n ]\n}"}],"_postman_id":"d39287c3-aad6-7501-e169-e7c512966cb9"},{"name":"Add an Employee","id":"71f432f9-385f-aee8-6002-5f860cce07da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"challengeAlgorithm":"","scope":"","grant_type":"","client_authentication":"","accessTokenUrl":"","accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\":\"264567\",\n \"FamilyName\":\"Smith\",\n \"FirstName\":\"John\",\n \"Gender\":\"Male\",\n \"DateOfBirth\":\"1975-08-16T00:00:00\"\n}"},"url":"{{url}}/People?$format=json","description":"

This request will insert a new Employee into the system.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["People"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"e0af7c74-1818-3642-0647-8b2b43281d0d","name":"Add an Employee","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\":\"264567\",\n\t\"FamilyName\":\"Smith\",\n\t\"FirstName\":\"John\",\n\t\"Gender\":\"Male\",\n\t\"DateOfBirth\":\"1975-08-16T00:00:00\"\n}"},"url":{"raw":"{{url}}/People?$format=json","host":["{{url}}"],"path":["People"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"884","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 17 Jan 2018 13:58:45 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/People('264567')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"436","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#People/@Element\",\n \"PersonGUID\": null,\n \"PersonCode\": \"264567\",\n \"FamilyName\": \"Smith\",\n \"FirstName\": \"John\",\n \"Salutation\": null,\n \"Gender\": \"Male\",\n \"ActiveEmployee\": null,\n \"DateOfBirth\": \"1975-08-16T00:00:00\",\n \"AdditionalFamilyNames\": null,\n \"FamilyNamePrefix\": null,\n \"FullName\": null,\n \"LegalName\": null,\n \"KnownAs\": null,\n \"SuffixTitle\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"CountryOfResidence\": null,\n \"AgeMonths\": null,\n \"AgeYears\": null,\n \"CityOfBirth\": null,\n \"Comments\": null,\n \"EthnicOrigin\": null,\n \"MiddleName\": null,\n \"MilitaryStatus\": null,\n \"Nationality\": null,\n \"PrimaryLanguage\": null,\n \"Race\": null,\n \"Picture\": null,\n \"TobaccoUser\": 0,\n \"DeceasedDate\": null,\n \"Deceased\": 0,\n \"Student\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:01.6774314Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"PersonPronouns\": null,\n \"BirthMonth\": \"August\",\n \"BirthYear\": 1975,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n}"}],"_postman_id":"71f432f9-385f-aee8-6002-5f860cce07da"},{"name":"Update an Employee","id":"c2ef5c6c-7234-4d01-9b00-85513e7f341c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"clientSecret":"","clientId":"","challengeAlgorithm":"","scope":"","grant_type":"","client_authentication":"","accessTokenUrl":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"FamilyName\":\"Jones\"\n}"},"url":"{{url}}/People(PersonCode='[PersonCode]')","description":"

This request will update an employee record in the system.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The [PersonCode] in the request needs to be replaced by the Person Code of an existing employee in the system.
The PersonCode cannot be updated as it is the key field for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["People(PersonCode='[PersonCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d038a8aa-82c7-4810-8304-45bc3df70d4e","name":"Update an Employee","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"FamilyName\":\"Jones\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/People(PersonCode='[PersonCode]')"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"DataServiceVersion","value":"1.0;"},{"key":"Date","value":"Mon, 23 Dec 2019 10:02:06 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c2ef5c6c-7234-4d01-9b00-85513e7f341c"},{"name":"Delete an Employee","id":"96ebd6c1-d30a-4170-9a95-9c2a661729cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"","username":"","showPassword":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/People(PersonCode='[PersonCode]')","description":"

This request will delete an Employee record from the system.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["People(PersonCode='[PersonCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"96ebd6c1-d30a-4170-9a95-9c2a661729cf"}],"id":"753bebef-f4e6-5f45-7a65-fbafc5e4f8ae","description":"

This API enables all information from the Personal Information screen for active and inactive employees to be retrieved and modified.

The identifying key for People is:

PersonCode

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonGUID	Y	Read-only.
PersonCode	Y	Key. Read-only.
FamilyName	Y
FirstName	Y
Salutation
Gender	Y
ActiveEmployee	Y	Read-only. 1 = Ticked, 0 = Not Ticked
DateOfBirth	Y
AdditionalFamilyNames	Y	Read-only.
FamilyNamePrefix
FullName
LegalName
KnownAs
SuffixTitle
CountyOfBirth
CountyOfBirthCode
CountryOfBirth
CountryOfResidence
AgeMonths		Read-only.
AgeYears		Read-only.
CityOfBirth
Comments
EthnicOrigin
MiddleName
MilitaryStatus
Nationality
PrimaryLanguage
Race
Picture
TobaccoUser		1 = Ticked, 0 = Not ticked
DeceasedDate
Deceased		1 = Ticked, 0 = Not ticked
Student		1 = Ticked, 0 = Not ticked
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
PersonPronouns
BirthMonth		Read-only.
BirthYear		Read-only.
FreeCheckbox1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeRichText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText4		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText5		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"b1641095-df0f-4622-9f15-3c3ff637d53b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a14b8032-49a2-4ab8-ae34-0cc946177c29","type":"text/javascript","exec":[""]}}],"_postman_id":"753bebef-f4e6-5f45-7a65-fbafc5e4f8ae"},{"name":"Disabilities","item":[{"name":"List of Employee Disabilities","id":"a4d1f03e-b4d8-6a87-9bf7-6e5e467511fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Disabilities?$format=json","description":"

This request will return a list of employee disabilities in the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Disabilities"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"188eb676-e890-9627-0681-575bc1ed86f4","name":"List of Disabilities","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/Disabilities?$format=json","host":["{{url}}"],"path":["Disabilities"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"506","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 13:39:48 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"427","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Disabilities\",\n \"value\": [\n {\n \"PersonCode\": \"27\",\n \"FullName\": \"Brenda Becker\",\n \"CertifiedDate\": \"2016-06-22T00:00:00\",\n \"DisabilityType\": null,\n \"DisabilityLevel\": \"Experiencing difficulties in multiple sensory or physical functions\",\n \"Percentage\": null,\n \"CertificateExpiry\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2016-06-22T08:41:12.76Z\",\n \"DisabilityDetails\": null,\n \"AdjustmentsRequired\": 0,\n \"AdjustmentDetails\": null\n }\n ]\n}"}],"_postman_id":"a4d1f03e-b4d8-6a87-9bf7-6e5e467511fb"},{"name":"Add an Employee's Disabilities","id":"30828bd3-e631-e538-7eb0-568ebfb10d98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"CertifiedDate\": \"2017-10-01T00:00:00\",\n \"DisabilityLevel\": \"Experiencing difficulty in just one function\"\n}"},"url":"{{url}}/Disabilities?$format=json","description":"

This request will insert a Disability record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Disabilities"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"799cfe64-0aae-ae7f-7c28-fa5984821336","name":"Add an Employee's Disabilities","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token","warning":""},{"key":"Content-Type","value":"application/json","warning":""}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"CertifiedDate\": \"2017-10-01T00:00:00\",\n\t\"DisabilityLevel\": \"Experiencing difficulty in just one function\"\n}"},"url":{"raw":"{{url}}/Disabilities?$format=json","host":["{{url}}"],"path":["Disabilities"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"464","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Tue, 17 Oct 2017 09:12:26 GMT","description":""},{"name":"location","key":"location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/Disabilities(CertifiedDate=datetime'2017-10-01T00%3A00%3A00',DisabilityLevel='Experiencing%20difficulty%20in%20just%20one%20function',PersonCode='26')","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"3333","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Disabilities/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"CertifiedDate\": \"2017-10-01T00:00:00\",\n \"DisabilityType\": null,\n \"DisabilityLevel\": \"Experiencing difficulty in just one function\",\n \"Percentage\": null,\n \"CertificateExpiry\": null,\n \"Comments\": null,\n \"InsertUser\": \"tammy.bell@omnicrom.com\",\n \"LastModifiedUser\": \"tammy.bell@omnicrom.com\",\n \"LastModifiedDate\": \"2017-10-03T12:50:35.8008473Z\"\n}"}],"_postman_id":"30828bd3-e631-e538-7eb0-568ebfb10d98"},{"name":"Update an Employee's Disabilities","id":"5b5da773-0955-41b9-af6a-c606c5657c6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/Disabilities(PersonCode='[PersonCode]', CertifiedDate=datetime'[CertifiedDate]', DisabilityLevel='[DisabilityLevel]')","description":"

This request will update an employee's Disabilities record in the system.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, CertifiedDate and DisabilityLevel cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Disabilities(PersonCode='[PersonCode]', CertifiedDate=datetime'[CertifiedDate]', DisabilityLevel='[DisabilityLevel]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b5da773-0955-41b9-af6a-c606c5657c6f"},{"name":"Delete an Employee's Disabilities","id":"d28e55bb-b1f2-7dcb-4b67-0560e677b3d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/Disabilities(PersonCode='[PersonCode]', CertifiedDate=datetime'[CertifiedDate]', DisabilityLevel='[DisabilityLevel]')","description":"

This request will delete an employee's Disablities record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

This API enables all information from the Disabilities tab on the Personal Information screen for active and inactive employees to be retrieved and modified.

The identifying keys for Deployments are:

PersonCode
CertifiedDate
DisabilityLevel

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
FullName		Read-only.
CertifiedDate	Y	Key.
DisabilityType
DisabilityLevel	Y	Key.
Percentage
CertificateExpiry
Comments
InsertUser
LastModifiedUser
LastModifiedDate
DisabilityDetails
AdjustmentsRequired		1 = Ticked, 0 = Not Ticked
AdjustmentDetails
FreeCheckbox1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeRichText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText4		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText5		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"84aee1fd-607b-429d-8cfc-cbb171f16206","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"436b4cb6-3eea-4240-b4f7-885f858b928a","type":"text/javascript","exec":[""]}}],"_postman_id":"ac93cb39-24e1-349d-d367-cfee28ed182e"},{"name":"Marital Status","item":[{"name":"List of Employees' Marital Status","id":"fefd3414-4459-56b9-a514-3b4d7613a208","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/MaritalStatus?$format=json","description":"

This request will return a list of Marital Status from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["MaritalStatus"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"4115fff9-1b1f-7f54-618a-c67808a667f6","name":"List of Marital Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/MaritalStatus?$format=json","host":["{{url}}"],"path":["MaritalStatus"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"434","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 15:24:56 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"461","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#MaritalStatus\",\n \"value\": [\n {\n \"MaritalStatusPersonGUID\": \"d700800d-6d24-425a-b678-d773c0fc4e50\",\n \"PersonCode\": \"26\",\n \"MaritalStatusDescription\": \"Married\",\n \"MaritalStatusDate\": \"2008-01-01T00:00:00\",\n \"MaritalStatusEndDate\": \"2014-04-23T00:00:00\",\n \"PreviousName\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2014-04-24T14:38:22.887Z\"\n }\n ]\n}"}],"_postman_id":"fefd3414-4459-56b9-a514-3b4d7613a208"},{"name":"Add an Employee's Marital Status","id":"3dc2575a-e693-3875-fdfc-c7d8de59397f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"MaritalStatusDescription\": \"Married\",\n \"MaritalStatusDate\": \"2017-12-10T00:00:00\"\n}"},"url":"{{url}}/MaritalStatus?$format=json","description":"

This request will insert a Marital Status record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["MaritalStatus"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"2acd812f-655f-31c9-b7c6-8146c92d6e55","name":"Add an Employee's Marital Status","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"Content-Type","value":"application/json; charset=UTF-8","warning":""}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"MaritalStatusDescription\": \"Married\",\n\t\"MaritalStatusDate\": \"2017-12-10T00:00:00\"\n}"},"url":{"raw":"{{url}}/MaritalStatus?$format=json","host":["{{url}}"],"path":["MaritalStatus"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"425","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 14:57:29 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/MaritalStatus(MaritalStatusDate=datetime'2017-12-10T00%3A00%3A00',MaritalStatusDescription='Married',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"808","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#MaritalStatus/@Element\",\n \"MaritalStatusPersonGUID\": null,\n \"PersonCode\": \"26\",\n \"MaritalStatusDescription\": \"Married\",\n \"MaritalStatusDate\": \"2017-12-10T00:00:00\",\n \"MaritalStatusEndDate\": \"2999-12-31T00:00:00\",\n \"PreviousName\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2018-01-02T09:00:01.7243344Z\"\n}"}],"_postman_id":"3dc2575a-e693-3875-fdfc-c7d8de59397f"},{"name":"Update an Employee's Marital Status","id":"7c84382b-f21d-4bc2-9ed9-8f7b9372b157","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/MaritalStatus(PersonCode='[PersonCode]', MaritalStatusDescription='[MaritalStatusDescription]', MaritalStatusDate=datetime'[MaritalStatusDate]')","description":"

This request will update an employee's Marital Status record in the system.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, MaritalStatusDescription and MaritalStatusDate cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["MaritalStatus(PersonCode='[PersonCode]', MaritalStatusDescription='[MaritalStatusDescription]', MaritalStatusDate=datetime'[MaritalStatusDate]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c84382b-f21d-4bc2-9ed9-8f7b9372b157"},{"name":"Delete an Employee's Marital Status","id":"694f1267-294c-899e-e8bc-d0b5f5fd000d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/MaritalStatus(PersonCode='[PersonCode]', MaritalStatusDescription='[MaritalStatusDescription]', MaritalStatusDate=datetime'[MaritalStatusDate]')","description":"

This request will delete an employee's Marital Status record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

This API enables all information from the Marital Status tab on the Personal Information screen for active and inactive employees to be retrieved and modified.

The identifying keys for Marital Status are:

PersonCode
MaritalStatusDescription
MaritalStatusDate

\n\n

Fields

\n\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
MaritalStatusPersonGUID		Read-only.
PersonCode	Y	Key. Read-only.
MaritalStatusDescription	Y	Key.
MaritalStatusDate	Y	Key.
MaritalStatusEndDate
PreviousName
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"4a835021-06b2-4171-82f5-c2aa68a7559e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9550348a-917b-4d48-a8cd-31795ef3330c","type":"text/javascript","exec":[""]}}],"_postman_id":"9c64c99e-af36-86c4-bfa1-aa29558699bf"},{"name":"Dependants","item":[{"name":"List of Employees' Dependants","id":"9983b7ad-97d5-aa83-e55f-c2e533faabf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Dependants?$format=json","description":"

This request will return a list of Dependants from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Dependants"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"dc0a3ab9-a8e9-6daa-238b-a9484ca749d8","name":"List of Dependants","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token]"}],"url":{"raw":"{{url}}/Dependants?$format=json","host":["{{url}}"],"path":["Dependants"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1011","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 11:44:30 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"401","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Dependants\",\n \"value\": [\n {\n \"PersonCode\": \"26\",\n \"FullName\": \"Cheryl Abrahams\",\n \"Relationship\": \"Child\",\n \"Salutation\": null,\n \"FirstName\": \"Mark\",\n \"MiddleName\": null,\n \"FamilyName\": \"Mac Gregor\",\n \"FamilyNamePrefix\": null,\n \"SuffixTitle\": null,\n \"AdditionalFamilyNames\": \"\",\n \"DateOfBirth\": \"2010-02-09T00:00:00\",\n \"AgeMonths\": 5,\n \"AgeYears\": 7,\n \"CityOfBirth\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"Deceased\": 0,\n \"DeceasedDate\": null,\n \"HomeNumber\": null,\n \"WorkNumber\": null,\n \"WorkExtension\": null,\n \"MobileNumber\": null,\n \"Email\": null,\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"AddressLine4\": null,\n \"AddressLine5\": null,\n \"City\": null,\n \"CountyCode\": null,\n \"County\": null,\n \"Country\": null,\n \"PostCode\": null,\n \"Disabled\": 0,\n \"TobaccoUser\": 0,\n \"Student\": 0,\n \"Gender\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T15:16:31.073Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"PayrollPartner\": 0,\n \"PartnerNINumber\": null\n }\n ]\n}"}],"_postman_id":"9983b7ad-97d5-aa83-e55f-c2e533faabf9"},{"name":"Add an Employee's Dependants","id":"ded27055-597e-6500-0af4-6280cabe2e4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\":\"26\",\n \"Relationship\":\"Child\",\n \"FirstName\":\"Mark\",\n \"FamilyName\":\"Abrahams\"\n}"},"url":"{{url}}/Dependants?$format=json","description":"

This request will insert a Dependants record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Dependants"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"1cfe7fbd-6118-34c5-f8d6-466f766cbc36","name":"Add an Employee's Dependants","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\":\"26\",\n\t\"Relationship\":\"Child\",\n\t\"FirstName\":\"Mark\",\n\t\"FamilyName\":\"Abrahams\"\n}"},"url":{"raw":"{{url}}/Dependants?$format=json","host":["{{url}}"],"path":["Dependants"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"960","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 16:32:54 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/Dependants(FamilyName='Abrahams',FirstName='Mark',PersonCode='26',Relationship='Child')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"594","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Dependants/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"Relationship\": \"Child\",\n \"Salutation\": null,\n \"FirstName\": \"Mark\",\n \"MiddleName\": null,\n \"FamilyName\": \"Abrahams\",\n \"FamilyNamePrefix\": null,\n \"SuffixTitle\": null,\n \"AdditionalFamilyNames\": null,\n \"DateOfBirth\": null,\n \"AgeMonths\": null,\n \"AgeYears\": null,\n \"CityOfBirth\": null,\n \"CountyOfBirth\": null,\n \"CountyOfBirthCode\": null,\n \"CountryOfBirth\": null,\n \"Deceased\": 0,\n \"DeceasedDate\": null,\n \"HomeNumber\": null,\n \"WorkNumber\": null,\n \"WorkExtension\": null,\n \"MobileNumber\": null,\n \"Email\": null,\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"AddressLine4\": null,\n \"AddressLine5\": null,\n \"City\": null,\n \"CountyCode\": null,\n \"County\": null,\n \"Country\": null,\n \"PostCode\": null,\n \"Disabled\": 0,\n \"TobaccoUser\": 0,\n \"Student\": 0,\n \"Gender\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.5993267Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"ded27055-597e-6500-0af4-6280cabe2e4e"},{"name":"Update an Employee's Dependants","id":"21b9035d-fd58-4c37-b994-08b36f9a6624","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/Dependants(PersonCode='[PersonCode]', Relationship='[Relationship]', FirstName='[FirstName], FamilyName='[FamilyName]')","description":"

This request will update an employee's Dependants record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, Relationship, FirstName and FamilyName cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Dependants(PersonCode='[PersonCode]', Relationship='[Relationship]', FirstName='[FirstName], FamilyName='[FamilyName]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"21b9035d-fd58-4c37-b994-08b36f9a6624"},{"name":"Delete an Employee's Dependants","id":"21b53213-0b06-91cd-f561-b2a7a21260e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/Dependants(PersonCode='[PersonCode]', Relationship='[Relationship]', FirstName='[FirstName], FamilyName='[FamilyName]')","description":"

This request will delete an employee's Dependants record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Dependants tab on the Contact Details screen for active and inactive employees to be retrieved and modified.

The identifying keys for Dependants are:

PersonCode
Relationship
FirstName
FamilyName

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
FullName		Read-only.
Relationship	Y	Key.
Salutation
FirstName	Y	Key.
MiddleName
FamilyName	Y	Key.
FamilyNamePrefix
SuffixTitle
AdditionalFamilyNames		Read-only.
DateOfBirth
AgeMonths		Read-only.
AgeYears		Read-only.
CityOfBirth
CountyOfBirth
CountyOfBirthCode
CountryOfBirth
Deceased		1 = Ticked, 0 = Not Ticked.
DeceasedDate
HomeNumber
WorkNumber
WorkExtension
MobileNumber
Email
AddressLine1
AddressLine2
AddressLine3
AddressLine4
AddressLine5
City
CountyCode
County
Country
PostCode
Disabled		1 = Ticked, 0 = Not Ticked.
TobaccoUser		1 = Ticked, 0 = Not Ticked.
Student		1 = Ticked, 0 = Not Ticked.
Gender
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
PayrollPartner		1 = Ticked, 0 = Not Ticked.
PartnerNINumber

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"0f18f480-5961-4f50-91e1-b69119088d4a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"43225dcc-5b19-4e53-a66a-b63f0ac38ad9","type":"text/javascript","exec":[""]}}],"_postman_id":"f2d1918f-d067-0ae6-dec8-926f0744e738"},{"name":"HAV Assessments","item":[{"name":"List of Employee HAV Assessments","id":"ba400071-c836-4300-b135-c13bd8bf49c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/HAVAssessments?$format=json","description":"

This request will return a list of employee HAV Assessments in the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

","urlObject":{"path":["HAVAssessments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"disabled":true,"key":"$top","value":"1"}],"variable":[]}},"response":[{"id":"64ff7429-8b5b-40f2-b54f-3f17d01d0bc5","name":"List of Employee HAV Assessments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":{"raw":"{{url}}/HAVAssessments?$format=json","host":["{{url}}"],"path":["HAVAssessments"],"query":[{"key":"$format","value":"json"},{"key":"$top","value":"1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"558","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":"Custom header"},{"key":"Date","value":"Mon, 04 Jun 2018 12:30:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#HAVAssessments\",\n \"value\": [\n {\n \"PersonCode\": \"CEZ003\",\n \"FullName\": \"Michael Andrews\",\n \"AssessmentDate\": \"2018-06-04T00:00:00\",\n \"AssessmentLevel\": \"Second Tier\",\n \"AssessmentOutcome\": \"HAV\",\n \"NextReviewDate\": \"2019-06-04T00:00:00\",\n \"IsRiddorReportable\": 1,\n \"RiddorCategory\": \"HAVS\",\n \"CurrentStatus\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2018-06-04T12:30:10.833Z\"\n }\n ]\n}"}],"_postman_id":"ba400071-c836-4300-b135-c13bd8bf49c5"},{"name":"Add an Employee's HAV Assessment","id":"948e5150-1450-4c48-b6f8-e38e92562269","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"100\",\n\t\"AssessmentDate\": \"2018-06-06T00:00:00\",\n\t\"AssessmentLevel\": \"First Tier\"\n}"},"url":"{{url}}/HAVAssessments?$format=json","description":"

This request will insert an HAV Assessment record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["HAVAssessments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"disabled":true,"key":"$top","value":"1"}],"variable":[]}},"response":[{"id":"59b2c817-a507-4df8-a3ea-b8cb2d6737b2","name":"Add an Employee's HAV Assessment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","warning":""},{"key":"Authorization","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"100\",\n\t\"AssessmentDate\": \"2018-06-06T00:00:00\",\n\t\"AssessmentLevel\": \"First Tier\"\n}"},"url":{"raw":"{{url}}/HAVAssessments?$format=json","host":["{{url}}"],"path":["HAVAssessments"],"query":[{"key":"$format","value":"json"},{"key":"$top","value":"1","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"492","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":"Custom header"},{"key":"Date","value":"Mon, 04 Jun 2018 14:22:31 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/HAVAssessments(AssessmentDate=datetime'2018-06-06T00%3A00%3A00',AssessmentLevel='First%20Tier',PersonCode='100')","name":"Location","description":"Used in redirection, or when a new resource has been created."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#HAVAssessments/@Element\",\n \"PersonCode\": \"100\",\n \"FullName\": null,\n \"AssessmentDate\": \"2018-06-06T00:00:00\",\n \"AssessmentLevel\": \"First Tier\",\n \"AssessmentOutcome\": null,\n \"NextReviewDate\": null,\n \"IsRiddorReportable\": 0,\n \"RiddorCategory\": null,\n \"CurrentStatus\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.con\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2018-06-04T12:28:26.0870744Z\"\n}"}],"_postman_id":"948e5150-1450-4c48-b6f8-e38e92562269"},{"name":"Update an Employee's HAV Assessment","id":"25da3f03-dd93-42ad-9d4d-5d0bbbd96992","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/HAVAssessments(PersonCode='[PersonCode]', AssessmentDate=datetime'[AssessmentDate]', AssessmentLevel='[AssessmentLevel]')","description":"

This request will update an employee's HAV Assessment record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, AssessmentDate and AssessmentLevel cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["HAVAssessments(PersonCode='[PersonCode]', AssessmentDate=datetime'[AssessmentDate]', AssessmentLevel='[AssessmentLevel]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"25da3f03-dd93-42ad-9d4d-5d0bbbd96992"},{"name":"Delete an Employee's HAV Assessment","id":"e08464dd-057c-4a8c-ba46-f53ceaef99da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/HAVAssessments(PersonCode='[PersonCode]', AssessmentDate=datetime'[AssessmentDate]', AssessmentLevel='[AssessmentLevel]')","description":"

This request will delete an employee's HAV Assessment record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

This API enables all information from the HAV Assessments screen for active and inactive employees to be retrieved and modified.

The identifying keys for Hav Assessments are:

PersonCode
AssessmentDate
AssessmentLevel

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
FullName	Y	Key.
AssessmentDate	Y	Key.
AssessmentLevel
AssessmentOutcome
NextReviewDate
IsRiddorReportable
RiddorCategory
CurrentStatus
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
NextAssessmentLevel

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"ccb0bdbb-edfd-41be-9860-435f9c7446bc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b569e176-6f5f-4015-ac10-3c1fcd49b939","type":"text/javascript","exec":[""]}}],"_postman_id":"7726be60-70ef-4e5a-aa82-c7a99320c5ee"},{"name":"Photos (Read-only)","item":[{"name":"List of Employee Photos","id":"ad238edc-e8e4-46d7-9696-caddcce40437","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Photos?$format=json","description":"

This request will return a list of Employee Photos from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Photos"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"disabled":true,"key":"$top","value":"1"}],"variable":[]}},"response":[{"id":"399b2245-3b31-453e-91ba-8a143e747cb6","name":"List of Employee Photos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token","disabled":false}],"url":{"raw":"{{url}}/Photos?$format=json","host":["{{url}}"],"path":["Photos"],"query":[{"key":"$format","value":"json"},{"key":"$top","value":"1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"10468","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":"Custom header"},{"key":"Date","value":"Fri, 01 Jun 2018 18:01:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Photos\",\n \"value\": [\n {\n \"Filename\": \"\",\n \"FileSize\": 5195,\n \"PictureType\": \"JPG\",\n \"Picture\": \"/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAIBAQIBAQICAgICAgICAwUDAwMDAwYEBAMFBwYHBwcGBwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wBDAQICAgMDAwYDAwYMCAcIDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCABzAF8DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD99NhAFIUORT8dB70r8Yp3JuRAYx/nvQ3SnGkYcVSKEbpQev50HkUdz+NMTQvf8aG6Gjv+NK3Q0Jk2E7/jSL98Uvf8aRfvigcQHUUH7hoHUUH7hpPYol7j8aD1FHcfjSnqKgloYV54rzr9qD9qvwB+xv8ACm78Z/EfxJY+G9CtTsV5iWmu5SCVhgiXLyyHBwqAnAJOACR1nxK+Iek/CT4ea74q166Wy0Tw3YT6nfzt0hghjaSRvwVTX8qH/BQr9ubxv/wU4/ab1HxXr1xcw6FbSyQ+HtFL5g0ay3fIgA4MrAAyP1dvRVVRXMkrs2o0Z1JcsT69/bv/AODpn4ofFXVr7SPgjptt8OvDQcxw6te28d5rdyv97Db4Ic/3VV2HUSV8UXP/AAVP/ad17WXupPjv8WBI53FYPEt3BHnOeI0cKB7AYrkLP4MxIiidgCOqrn8s/wCegrqfD/wy0+KVStvISTySOv1rjnmMY7H0NHh6ct0e6/s4f8F//wBqn4B6ratdeOB470mJh5uneKLVLwTDqf3423AOOmJMexr9if8Agml/wXj+F37f11a+F9VT/hXnxKmASPRNQuA9vqrY/wCXO4wokb/pmwWTrgOAWr8MJPgzYX9mZGs5EaTBEi/ln0rnvEvwCewjS70uZ7e6tnEscisUZGXkMrDoQcEEelRTzOEnaReJ4aqRjzQ3P62O/wCNNX7wr8+P+CAn/BSvWv2yvg1qngLx/eSXvxG+HUcQe/mOZdb09srHcOepljYeXI38WY2JLM1foQv3xXo3XQ+XlBxfKwHUUH7hoHUUH7hpPYRMRQRyKcP8/pSH+lQM+JP+DhTx/c+CP+CWXjq2tJWhn8S3Wn6PuU4by5LuN5V9w0cbqR6Ma/n8+Evwxl1vU4ba2izcMwwD8u/+n/6jX7ff8HKPjrQL/wDY90jwoniHRF8SweJtP1abRTex/b3s/LuovOEG7zPLEjoN+MZ4r8wfhN4bg8BJp2oyQm7N1kHyxyjHgADOCcMOCMdfrXJi5pJJ9T6TIaDk3JHefCj9h/R77Rxd+Ir+BfNiVwIgWZQQD0GTznGT064rL8cfs8aZ4OnCWayvEVJjc7Vzz7HPbv1xXsEHxOsP7NktteurXwjuAdGvJljeUHp8oPA7jjHHArm/FvhGHULRn0zXoNbikBYGGYsRnpznvnPPr2rjxEaMaV0j6rBurOvyp6nZfsv/ALK2k+NPDpe9Q3CykxFBc+U+DtIY8cDkjJwMgV2/xz/YE0KG236Vp0lkqLlsnLAggDPPlkYPOCOT7VQ/ZYsdV13T7PSl1638OaZaMGurmafqQORg98Y4zznocV7D8TviRoY0/wD4R7wP4u8NeNNfcYuIvt8knlKOufKV8HOOpUAkc8YqML7CrRulsGYfWKOJtJ2v0PlP/gljo95+yv8A8FbPBts7eVaeJlvNBvCpGJElgd41/wDAiKH8q/eQKQ1fg7oHxZ/4VP8AtQeDfHXi3R9XvZPCHiKC5ntdMhW4u5kDsT5allDfezyV4XNfu5omrQ+ItGtL+3L/AGe+hSeLcpVtrqGGQeQcEcV6WDqKVNW6HxWe0HTxF7bkw6ig/cNOPNIw+U11dDxicf5/SkPf6Uo/z+lIe/0qQP56v+Co3xF0/wAZ/wDBSn41R+Plu5Y7TWtO0Lw9aoxL2qx2kQaZBtPylJA5AK5MgPOCDY+Az2Om6Ba3t3ZPfy2tilzhVy27oCB68H9K9b/4OAP2Ur3wD+3L4e+KtjbSPpniq2hlmkSAyrHd26LbTh1AxhrYW+GJGCDwa4b4NeHo9K8TW6Qo/wBmn0q2miXfgFWjU5yewbP5e1eFiua8ova5+jZVKnKFKUFZ2/I86/aN+Jmp/GHSvCFxe+BI2i8Xaw3h6zls7YyNLNG0aO8jPKrqUMkYY+WqjPDEVxeg+Btb/Z//AGpdU+GkRubTVbAYnglXMS9flLcrwc4KMyH+Fm7e7/GLxJe+GZCbW/isjp7GaGW2DQmNsH52Mbrk4J5Oe/auB+GvgaC11hvFusa1fajqOpykzXUi48tI8hEQ/wC8Tn8etee8TSnBxSd+p9FTy7EU60Zyat0VtTq/j/e+J/gx+zX/AGy1rcXUOo3DuY7J9rrsYoWkcA7EDdT24rnf2JLz4ieH/jRc6Tos2j6NZal4XfVxrUcifZVleIutrKxhmdpc4Taok+chQD2+hPDR8I/EfwCfDl+73MNzd3kcsfmFhLbyHJzngckkEc554wK57wb8D9C/Z/8AHr2GnzXV/ZLMY/KncPIyemR82CPfB2niubB4mEFKKjfXud2aZdWqzjJztp23+84H4neF9Y174HwTeJZIo9T8V2dwmTgtAZE8oFtp4P7zJx0/DFfuV+zvpV/ofwB8DWWqXH2rU7PQLCC7m/57TLbRh2/FgT+Nfln+2P8ADC48W+M/Cmm6Ro95fTa3aJFbaTbxlZJMRsWCBQSDjoQDggHFfrh4btnsvD9hDJF5DxQRo0e4N5ZCgEZHBx617eTppST6HwPGUk/Z2e+vmWgOaHXqKVetD9a93ofDdbEo/wA/pSHv9KUf5/SkPf6VIzH8c/DvQPidoo03xJoekeINO3rN9l1Kzjuod6/dbZICuR2OMivxa+Os0HwJ+KWoWyRJbr4c1K80mECMFCsNxIqrj0+U49c1+x/x3+PHhL9mb4Vav428ca3aeH/DOhwiW7vLjJC5ICqqgFndmIVUUFmJAAJr8rf+C1XwmuPAHjS88R2lrcR6R8Qlj1azdk2m3ulRPOiPUB+A+O/mHGcGubF0eem9D18mxTpYhanyP+038e7z4veI1XQ9NEE15GsbxqpEVuTx8x/PArqPgonhT4R/D7T5PGtnrmtPbuyTW1jKoiwX3b2PMh4JGFTjHcV5D8PfF7R+JLe5tbS3mvtzYtrhysDuykfMV5A4UZ6/WvT7Pwj4g8e+HZprvQpnHmGKQ6OZLiKJz0UkMWH449q8f6nTlF9D9Io5liOdWV+x9Mfs4eKvh/Ja6xPbaNH4gk1OMfYITdvbvZKOTljgE/dHJ68d8VzH7Snwol8PeJ9K8aeGNTjS4ilQ3Vk1w0keAAAVcgEkYGWwM+1cN+zt8G9S0jx7ambRfE0txtEa2/2e6txKpHG13G3PrzxjNa/x7t/F/g7W7gPqOnxaQpU3GmoGnuIpM42NOWwRjGQF5JxxisMPgaVOPMztzHH4uU9VZad/1PoT/gm18ar79pv9uTw9qN/GAvhvTrtbdRnEaiF4yx9zvAz7Gv1K7/jX5pf8EGvg3LceMfG/jxoSmn2cI0S1k2/JLM7LLNtPqgVM/wDXav0uIwa93BU+Sn66n5dn+IVXFu3RJDF60r9aRetK/Wuy54djH+IvxO8OfCDwnc694r17R/DeiWYzPf6neR2tvF6Au5C5PYZya+M/i5/wcZ/so/CtLyO38eXviq9tEYi30XSLmQTOoyESWVI4iTjAO/bzya/no+Pv7SHxH/ad8SRap4+8YeJPFt82fLbUr2SdIQWOVjQnZGvH3UAHtXjt1p0sl3EAGYeYF4XdnPsevSu6OES3M+ds+3v+CoP/AAWG8ff8FOdTFpcW6+Gvh9pU5udK8O2snmneAVFxcy4Hmy7WIBwFUMQqglmb9mf2K/H/AIU/4LP/APBK3Q7XxVIX1eK2XR9ZmgK/atJ1e1QILuM4IVnVklA5BWYocjcK/m10awlj07y3guCnYuohjH17H8wa+uf+CK//AAUmvf8AgnF+1MLbV5RL8NvHbxWevW0bmT7IwJEV4gBPzRlmBA+8jMMZ2kbVKCcLJChNxldGx+2d+xd8Tv8Agnx8ZF03xck15pF5M50nXrVSLPVYweq/3JAMboj8y57qQxXwP8VNR0rbcaTezadeXCASEfPDcY6blPB5/EV/Qt8Tvhv4H/au+DEml69YaX4v8IeIrZJ4wSJIpkYZjmidTlWAOVdCCOoNfln+0N/wb0+M9A127vfhJ4ig1TR5GLxaXrE32e7gB6IsoHlyfVgn49a8HEYHmd4n12V5+6a5ajseQ/C/42/EnxTK8f8AwkWj24tQNrpAFnbP9w7uvNdP4R+GfiX9pr4u+H/AmlTn+1tZn/eSzvv8mNAWkuJCONqjLYHUjAySK+cfi38D/ix+xdZXOpeNPC+p6PptheNaNqsTR3ln9oB2eSJoGdPNLZUR53ZyMZBFfqz/AMEPf2Gta+G/g1vjN8Q4Lm18aeM7LydM0q4bMmiaezBsyj/n4lKqWH/LNAqDkyFuaOXvmvNWSPXx3ET9g3GV5PRH2f8As8/AfQv2afg9ovgzw5CY9O0eHZ5jgebdSnLSTSEdXdiSfrgYAArtSK/Lr9q3/gvR4j/YU/4KI+O/ht4t8JW3irwDo1zY/ZbmxP2bVLOO4sLa4OCT5UwVpWAVgh6ZfpX3H+yR+3t8K/23vCo1L4e+KrLVJ44xJdaZKfI1Kw7fvYG+YDJxuGUJ6Ma9Z0ZRje2h8BKfNK8tz2Apg01+tPPJprLmswP5BLDwet41iApO+fyzxyQGU/8As1c6/hETajDbBUx5olffnGArDtz1YV6ZHCbW1s2CgeXcs/Ax0EZ/pWHPDceGNfvJ/sxuII9sMjKiyGIBjltpGccjkc+1fRcqOW5nnwE1nAX+z2AU4PzTFc/m9Zr+G45JFLi1gG7ose8p7knPt0J+ld+NfsvEmnA2s9ndNEu+VdjRPGOnIwp6kVT1DTlgiLEKtnedNoP7pgPqTlSefUHPcYOVBc/aX/g3e/aX1bxF8B5PAWuPNd2ejM0mm3Ltu+zgt89uT6ZYOvs57Yr7Y/bq/aZs/wBjb9j74gfEyZYpJfC2kSz2UT/duLx8RW0Z9mneNT7E1+K3/BD39sH/AIUD8dL7wVrbKdF8VQkxMELyQ3EY3I8eOTuTd8oBL4RVBbYK+jv+Dj/9pV9X/Y28G+BtOvopG8R6y2qXDxOGW7tbWL5BkcFHe4jcHv5QxXHUw/NUT6GkW2fDUHjfWj431HUZdc1Epd37SmNp2YyyuVaSVueSzsWY9++a/QX9h39p/U/2Z/FXw+s0uri48M+MNVj07UredsIFmBUXCDopjfaxI6oHHPBH5v3yl7+1mgurPZqEFvkG5VW83ykDIcnhs5BB9V9a+oPBSr8TvEPgLwvoF/bX0+l2iYaGdZDFfzTLEiuVJwwXzSQeeQa+0xdGm8LJSWljmp3c0keW/wDBxH4Wm8Pf8FWvE815b3Ig8T6Lpd3ZEcJKFtkt2IODn5oCMDuPz+SPhz4m8QfCbxRY67oGq6l4e1ewn3Wd5aXjW93A4GQysu1gDkjI9D+P7Bf8HSf7N6eIvgT4G+K9rADf+Er4aVeyquWNvPllz/shw/J9R61+QF3ocZiju7e389JADncdqZAYHAx69SccGvjaCTgjpnufqn+w/wD8HJ+o+EtKttA+O2hXmtpAoij8S6LDGt02OP8ASbYlUYju8ZU4A+RiSa/T/wDZo/bP+GX7YPh6TUvh74u0zX1t1DXNqhMV5Z56ebA4EiDPAYrtJBwTX8wekabFqFrlim7hJipBCMc7W6dOxx/Wr3hPxJ4l+EniKLVvCuta54a1iFXijvNMu5LW5QEAOgeMhuh5GeQairg4vVaBGTRDqICWUaAAKsj4GPULUWpRKbzWjzlSwHP/AE3joor0nsYFDwRCn9pwTlVMvneQWIyTGWOVPqDuOR3zWlfQKr6jCAfKVXIXPQqcKfyJ/OiipexRB8NtdvPC/ijSNX0+4ktNT0fVbaWyuIzh7ZwxcFfoygj0P1NfpF/wczeBdI8J23w+fTbGGzMn2pSseQgDOjsAucKCzE4AHWiisH8cTWjueRfs82kXiDwzFa3kUc9vHZWlyqFQAJCuwtx6qiAjodor61/4JT+AdF1n9trxnBc6bayxW+mW2sRqUxtu4bnZFNx/EqSyAezmiivqMx/3KT8kc0fiR9Zf8Fj/AA5Y+I/+CYvxltb62juYIPDktzGr/wAEkTo8bg9cqyg/hX85Xwt/0/wlp6zfvFdY1YNzkbDRRXx2C6nTM7vQtDtbXw/aukID3EMxkOSd21AR+ROaqa5AhhztAJhRyRwSQdufyNFFd5mz/9k=\",\n \"ThumbNail\": \"/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCABkAFMDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD32iloNACUUUd6YBmisu98R6Jpsnl3ur2Nu/8AdlnVT/On2WvaRqbbbHVLO5b0imVj+hoA0aM0UlAhc0ZpKKBgTzRQetFIB1FFFAFXUL+10uwnvr6ZYbaBS8kjHgCvnvxp8XNW8QySWeitJp+mZxuU4llHqT/CPYV1Hx01iZv7N0CFyscgNzMAfvYOFB/HJ/KvLLLTyyhUj3Ofak5WNadPmMQW0szlyGZmOSzck/U1ajsJ42WSMOrDkMhwR+NdKdEvIRmSIqPpV2w0iW6YoinNZubOhUI2NHwh8VtZ8PyR2utGXUNNyBubmWIeoP8AEPY175p+oWmq6fDfWMyzW06743XoRXz1feF7uGEedCCGGcDk113wZ1Ka0vdQ8PzMfJK/aIFP8JzhgPzBq4yvuY1aXLqj2CiiirMAPWig9aKQDqDRVe/ufsenXN1gnyYmkwO+BmgDw34rxvd/EDy9pOy1jC/jk1V0Rba1jG51Eh4zjmsqK7m1S8gv7u9ea8mTdIjsW2A5IAJ7e3at1WsbaLyfKlkuJ1ypj6j/AOt9KyctTupwsrMs332l1O6EsnYntRoM5gkkAiMkjHCoveuVF7dQW8WoxXUzWU0pjXzScFh1HNdHBdXFnZz3/lNGI0Hzj+E+tRObTub04JxZ2d/ugsPNvLby8jhVUsfyFc94Rkt4/iDaXayJDHIskZ3kDJI4H1zjisPRNa1C61mMyRT3TTwvNEJnOzaM9s4HTvVhknmnsbpLdUuZJ0kjRhx94f0zVuWqMXC8Wj3uiiitTgEPWig9aKAHU2WNZonicZVwVI9jTqKAPm8aFLo3iK/06ZCGRmMZx1ABxg+mMVvR/u7KKZQu9V4Y9R24r03xraRPoMlz5SedE6HftG7GcHn05ryO41d7W3ms1TIPHPUH2rCcbbHfQqKW5TlSS+aO1kn/ANFtj5iwheN3rXQWE1sYJIHlZgyqAPUgnt9K5zTISkz3V4N4ZeEDY/Wuh0rV9Pa8VzZxxsBsETHKk+uaykpHZCUNWNt9Jt9IvAkMrvG3RCeQD2FbU+nvL4p0yOCB2AZJBGvG1QRk/Ss7V7WGYR3ls4juIiCQn3celbvw9vZ9V1+5up+Wig2D2Gf/AK1XGLurmFWaUW0elUtJSiuk8saetFKetFAC0V5P4g+OOmWitFolnJey/wDPWX5Ix/U153rHxg8V6zbSWn2iCzik4Y2yFWx6biSafKxXPb5/FOmaz4qm8HxFJc2rvPMG4VuBsHqecn0xXjnia1uNG12e1uwFdeOf417MPYiuR0bV7nw/rdlrFsSZLeQORn76/wAQ98jNfR2raJonxG8OWt4jj95HvtrpPvRk9VPqM9RRKBpTnys8fspVmEYkvGWMjaAy5Rfy5rZs9KUSpMJ7UjOfvHisHVtA1Twndta6hEwjJ/dzoMxyD2P9Khs7mzE4aSLcB15xWLTO+FSNjp9Zjg8zzY7pnK8ZU4Rj9K774b6TJZ6PLfzIVe8YFAeuwdD+PWuK8KWEHiPxHFarG8lnbjzZz2A7L+J/rXsVteWU8sltbTwtJAdkkSMMx+xHaqinuznxE18KLNFFFWcoh60UHrRQB8cG3JA47VAlv+8HrjnmtkIAEGMkgiobYIJSrZ3E8D1Fb2JKZiG3+H8cmvRfhN4sm0LUv7HunLaddNkZ/wCWTnuPY9642WPLEDOR0GKfp9wtjqMFyylolcFl9u4oaA+qLiyt72Ix3EUc0TdUdQwNeI+M/wDhHo9du7Cw0lIzGNguIJCNsg+9lehAPGPavVhr9vb+HJdRikDwx2pljJPXA4B/HFfPVnNLcWi3Mm5pJpJDIepyWz/WilBSlqPma2PXvhxqOn6Tp0Ol+R5LTycXDNlppD3b09u1ebePrm7034m6tcWU8tvOsqOskb7Tyi/4Vt2Ukq2ulhB++83zRj/ZIx+tL8ZtF+y+JLHWUXCXsYik9N69P0p1IKMtAu2tS/4V+Mc8ey28RReanT7XCvzD/eXv9RXrun6lZararc2F1FcQsMh42z/+qvk/aVcKx9gAKu2V1faXOLiwu5raUH70Tlf/ANdZuHYLn1Yc5orwu3+MniCC3jils7K4kQYMrBgX9yBxRU8rHc4XADR8d6rSqrQ/MoPzd6KK3IJYkCwNjPy4K89M0yTHmLwPnxmiikB6TooN18INSeRm3RM8IweqjBGfzx9K5Pw3BFcWAWWMMGLc5PGOaKKuj8Q3sdz4R0y2l8WiN1YosIkUbjwVI6fXvW78ZbeKbwDJM6/vLeeN429CTg0UVFb4wWx4ioEkSluvt9ateWqgKBwMiiigCBwAxxxRRRQI/9k=\",\n \"PersonCode\": \"544B7D04-AA4F-4393-9D5D-2C800CFCFDE8\",\n \"FullName\": \"Mandy Langford\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2010-06-26T18:04:53.777Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"ad238edc-e8e4-46d7-9696-caddcce40437"}],"id":"14e57346-5605-44ab-9427-d9aec4a19b36","description":"

This API enables all photo details for active and inactive employees to be retrieved and modified.

The identifying key for Photos is:

PersonCode

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
Filename		Read-only.
FileSize		Read-only.
PictureType		Read-only.
Picture		Read-only.
ThumbNail		Read-only.
PersonCode	Y	Key. Read-only.
FullName		Read-only.
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"e2aa0111-d9b6-4a7c-9a72-fcfd2211ea9f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bb25ffc9-eff9-4977-b71d-3ad5a2fb8bde","type":"text/javascript","exec":[""]}}],"_postman_id":"14e57346-5605-44ab-9427-d9aec4a19b36"},{"name":"Genders Picklist (Read-only)","item":[{"name":"List of Genders","id":"934fe5a4-b88a-4643-8e9f-00590c2750e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Genders?$format=json","description":"

This request will return a list of Employee Photos from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Genders"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"disabled":true,"key":"$top","value":"1"}],"variable":[]}},"response":[],"_postman_id":"934fe5a4-b88a-4643-8e9f-00590c2750e2"}],"id":"93f533d7-5956-4b7c-8913-e6fe361ea186","description":"

This API enables all gender picklist items to be retrieved.

The identifying key for Genders is:

CodeGuid

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
CodeGuid		Key. Read-only.
Code		Read-only.
CodeDescription		Read-only.
SortOrder		Read-only.
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
Colour		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to all items.
Restricted HR Professional	Has read-only access to all items.
Line Manager	Has read-only access to all items.
Self Service	Has read-only access to all items.

","_postman_id":"93f533d7-5956-4b7c-8913-e6fe361ea186"},{"name":"Address Types Picklist (Read-only)","item":[{"name":"List of Address Types","id":"d9a6481c-b876-47b4-a5f8-e9850623019d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Genders?$format=json","description":"

This request will return a list of Employee Photos from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Genders"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"disabled":true,"key":"$top","value":"1"}],"variable":[]}},"response":[],"_postman_id":"d9a6481c-b876-47b4-a5f8-e9850623019d"}],"id":"6d6cc630-6428-4ac5-903d-fad3a3912c07","description":"

This API enables all address types picklist items to be retrieved.

The identifying key for Address Types is:

CodeGuid

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
CodeGuid		Key. Read-only.
Code		Read-only.
CodeDescription		Read-only.
SortOrder		Read-only.
OverlappingAddressesNotAllowed		Read-only.
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to all items.
Restricted HR Professional	Has read-only access to all items.
Line Manager	Has read-only access to all items.
Self Service	Has read-only access to all items.

","_postman_id":"6d6cc630-6428-4ac5-903d-fad3a3912c07"}],"id":"527dd309-ab58-75cb-384e-7780f4fcbf84","_postman_id":"527dd309-ab58-75cb-384e-7780f4fcbf84","description":""},{"name":"Contact Details","item":[{"name":"Emergency Contacts","item":[{"name":"List of Employee Emergency Contacts","id":"ae844336-be28-031c-e81d-e4be396e5049","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/EmergencyContacts?$format=json","description":"

This request will return a list of Emergency Contacts from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["EmergencyContacts"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"805cb665-b2e9-9e58-3d18-54b1a50dbf08","name":"List of Emergency Contacts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token "}],"url":{"raw":"{{url}}/EmergencyContacts?$format=json","host":["{{url}}"],"path":["EmergencyContacts"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"737","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 14:18:42 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"558","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#EmergencyContacts\",\n \"value\": [\n {\n \"PersonCode\": \"27\",\n \"FullName\": \"Brenda Becker\",\n \"Relationship\": \"Parent\",\n \"Priority\": 1,\n \"Salutation\": null,\n \"FirstName\": \"James\",\n \"MiddleName\": null,\n \"FamilyName\": \"Becker\",\n \"FamilyNamePrefix\": null,\n \"HomeNumber\": null,\n \"WorkNumber\": null,\n \"WorkExtension\": null,\n \"MobileNumber\": \"07780 7001111\",\n \"Email\": null,\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"AddressLine4\": null,\n \"AddressLine5\": null,\n \"City\": null,\n \"County\": null,\n \"CountyCode\": null,\n \"Country\": null,\n \"PostCode\": null,\n \"Comments\": null,\n \"InsertUser\": \"* cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-05-05T11:29:47.25Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"ae844336-be28-031c-e81d-e4be396e5049"},{"name":"Add an Employee's Emergency Contacts","id":"4a6a3419-53b2-b8e5-dbe8-b2c7b59868c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\":\"26\",\n \"Relationship\":\"Parent\",\n \"Priority\":\"1\",\n \"FirstName\":\"John\",\n \"FamilyName\":\"Smith\"\n}"},"url":"{{url}}/EmergencyContacts?$format=json","description":"

This request will insert an Emergency Contacts record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["EmergencyContacts"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"9c009b26-9149-4c2c-9efd-3f19070523c8","name":"Add an Employee's Emergency Contacts","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\":\"26\",\n\t\"Relationship\":\"Parent\",\n\t\"Priority\":\"1\",\n\t\"FirstName\":\"John\",\n\t\"FamilyName\":\"Smith\"\n}"},"url":{"raw":"{{url}}/EmergencyContacts?$format=json","host":["{{url}}"],"path":["EmergencyContacts"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"703","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 16:37:00 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/EmergencyContacts(FamilyName='Smith',FirstName='John',PersonCode='26',Relationship='Parent')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"603","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#EmergencyContacts/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"Relationship\": \"Parent\",\n \"Priority\": 1,\n \"Salutation\": null,\n \"FirstName\": \"John\",\n \"MiddleName\": null,\n \"FamilyName\": \"Smith\",\n \"FamilyNamePrefix\": null,\n \"HomeNumber\": null,\n \"WorkNumber\": null,\n \"WorkExtension\": null,\n \"MobileNumber\": null,\n \"Email\": null,\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"AddressLine4\": null,\n \"AddressLine5\": null,\n \"City\": null,\n \"County\": null,\n \"CountyCode\": null,\n \"Country\": null,\n \"PostCode\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.6774552Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"4a6a3419-53b2-b8e5-dbe8-b2c7b59868c2"},{"name":"Update an Employee's Emergency Contacts","id":"9d17a075-ba42-4fbf-8339-24c3967620d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/EmergencyContacts(PersonCode='[PersonCode]', Relationship='[Relationship]', FirstName='[FirstName]', FamilyName='[FamilyName]')","description":"

This request will update an employee's Emergency Contacts record in the system.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, Relationship, FirstName and FamilyName cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["EmergencyContacts(PersonCode='[PersonCode]', Relationship='[Relationship]', FirstName='[FirstName]', FamilyName='[FamilyName]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d17a075-ba42-4fbf-8339-24c3967620d1"},{"name":"Delete an Employee's Emergency Contacts","id":"f3470375-405b-9fca-c479-9fdea30a8a70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/EmergencyContacts(PersonCode='[PersonCode]', Relationship='[Relationship]', FirstName='[FirstName]', FamilyName='[FamilyName]')","description":"

This request will delete an employee's Emergency Contacts record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Emergency Contacts tab on the Contact Details screen for active and inactive employees to be retrieved and modified.

The identifying keys for Employment Contracts are:

PersonCode
Relationship
FirstName

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCode	Y	Key.
FullName		Read-only.
Relationship	Y	Key.
Pritority	Y
Salutation
FirstName	Y	Key.
MiddleName
FamilyName	Y	Key.
FamilyNamePrefix
HomeNumber
WorkNumber
WorkExtension
MobileNumber
Email
AddressLine1
AddressLine2
AddressLine3
AddressLine4
AddressLine5
City
County
CountyCode
Country
PostCode
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"c05ccd4b-bcbc-4cc5-ba26-c1c442c18785","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d5ce364a-6dde-4234-84cc-af7b4af11630","type":"text/javascript","exec":[""]}}],"_postman_id":"e376ac94-1399-2cd5-04c0-2e5b3bc4bdd5"},{"name":"Communications","item":[{"name":"List of Employee Contact Details","id":"e4563ab9-1325-5187-01df-275c0874faad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Communications?$format=json","description":"

This request will return a list of Contact Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Communications"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"6d40e976-c8a9-80b1-0288-d318c34e53e2","name":"List of Employee Contact Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/Communications?$format=json","host":["{{url}}"],"path":["Communications"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"content-length","key":"content-length","value":"611","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Wed, 16 Aug 2017 10:21:14 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"1026","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Communications\",\n \"value\": [\n {\n \"PersonGUID\": \"ba97079f-3f33-416a-b23b-91df336d0075\",\n \"PersonCode\": \"0029\",\n \"FullName\": \"Bill Morrow\",\n \"WorkNumber\": \"01173665001\",\n \"WorkExtension\": null,\n \"HomeNumber\": null,\n \"MobileNumber\": null,\n \"PersonalMobileNumber\": 7272727272,\n \"OtherNumber\": null,\n \"FaxNumber\": null,\n \"PagerNumber\": null,\n \"SkypeName\": null,\n \"Messenger\": null,\n \"InternalEmail\": \"BillMorrow@omnicrom.com\",\n \"ExternalEmail\": null,\n \"AlternateEmail\": null,\n \"HTMLPreferred\": 1,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-02-15T13:49:20.25Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n }\n ]\n}"}],"_postman_id":"e4563ab9-1325-5187-01df-275c0874faad"},{"name":"Add an Employee's Contact Details","id":"4dbcac38-72ad-9e81-70b3-e8b80f80ce8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\":\"CEZ01\"\n}"},"url":"{{url}}/Communications?$format=json","description":"

This request will insert a Contact Details record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Communications"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"f65d0ac5-15b8-2149-7770-8d5dcfc268af","name":"Add an Employee's Contact Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\":\"CE14\"\n}"},"url":{"raw":"{{url}}/Communications?$format=json","host":["{{url}}"],"path":["Communications"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"576","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 16:41:04 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/Communications('CE14')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"429","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Communications/@Element\",\n \"PersonGUID\": null,\n \"PersonCode\": \"CEZ01\",\n \"FullName\": null,\n \"WorkNumber\": null,\n \"WorkExtension\": null,\n \"HomeNumber\": null,\n \"MobileNumber\": null,\n \"PersonalMobileNumber\": null,\n \"OtherNumber\": null,\n \"FaxNumber\": null,\n \"PagerNumber\": null,\n \"SkypeName\": null,\n \"Messenger\": null,\n \"InternalEmail\": null,\n \"ExternalEmail\": null,\n \"AlternateEmail\": null,\n \"HTMLPreferred\": 1,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.5368266Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n}"}],"_postman_id":"4dbcac38-72ad-9e81-70b3-e8b80f80ce8d"},{"name":"Update an Employee's Contact Details","id":"fa247a16-0598-4a0f-85fd-8fe08265668b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/Communications(PersonCode='[PersonCode]')","description":"

This request will update an employee's Contact Details record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode cannot be updated as this is the the key field for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Communications(PersonCode='[PersonCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa247a16-0598-4a0f-85fd-8fe08265668b"},{"name":"Delete an Employee's Contact Details","id":"e9f747c2-81a6-22a7-0073-1b9593b739ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/Communications(PersonCode='[PersonCode]')","description":"

This request will delete an employee's Contact Details record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Communications(PersonCode='[PersonCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9f747c2-81a6-22a7-0073-1b9593b739ff"}],"id":"06cace2d-07e7-684d-c38c-04b8f11978c8","description":"

This API enables all information from the Communication tab on the Contact Details screen for active and inactive employees to be retrieved and modified through this API.

The identifying key for Communications is:

PersonCode

\n\n\n

Field	Mandatory	Comments
PersonGUID		Read-only.
PersonCode	Y	Key.
FullName		Read-only.
WorkNumber
WorkExtension
HomeNumber
MobileNumber
PersonalMobileNumber
OtherNumber
FaxNumber
PagerNumber
SkypeName
Messenger
InternalEmail
ExternalEmail
AlternateEmail
HTMLPreferred		1 = Ticked, 0 = Not Ticked.
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
FreeCheckbox1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeRichText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText4		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText5		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"72b64f99-78be-44da-82e4-37f85524d2ec","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"77835b37-086f-4220-a576-1aafdff35a2d","type":"text/javascript","exec":[""]}}],"_postman_id":"06cace2d-07e7-684d-c38c-04b8f11978c8"},{"name":"Addresses","item":[{"name":"List of Employee Addresses","id":"947dc1fb-f262-b362-a478-a43e23c25733","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Addresses?$format=json","description":"

This request will return a list of Addresses from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Addresses"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"f868083c-d1c4-e7da-151c-db5009531276","name":"List of Employee Addresses","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/Addresses?$format=json&$top=1","host":["{{url}}"],"path":["Addresses"],"query":[{"key":"$format","value":"json"},{"key":"$top","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"661","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 17 Jan 2018 17:11:52 GMT","name":"Date","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"664","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Addresses\",\n \"value\": [\n {\n \"PersonGUID\": \"ee552c7c-9462-40t3-a2b7-ttrr6734a9fe\",\n \"PersonCode\": \"24377\",\n \"FullName\": \"Mr Howell\",\n \"Salutation\": null,\n \"EffectiveFrom\": \"2009-08-29T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"AddressType\": \"Home\",\n \"AddressLine1\": \"10 Weavers Way\",\n \"AddressLine2\": \"West Molesey\",\n \"AddressLine3\": \"Surrey\",\n \"AddressLine4\": null,\n \"AddressLine5\": null,\n \"City\": null,\n \"County\": null,\n \"CountyCode\": null,\n \"Country\": \"United Kingdom\",\n \"PostCode\": \"KT8 1SG\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:45:26.043Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"947dc1fb-f262-b362-a478-a43e23c25733"},{"name":"Add an Employee's Address","id":"d3aa27e3-802c-ba0c-8fcd-6e5b451b82d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"","username":"","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":"{\r\n \"PersonCode\": \"100\",\r\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\r\n \"AddressType\": \"Home\",\r\n \"AddressLine1\": \"24 First Street\"\r\n}"},"url":"{{url}}/Addresses?$format=json","description":"

This request will insert an Address Details record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
If the EffectiveTo is left blank, the system will try to insert the record with EffectiveTo set to Open Ended.
If the AddressType has the 'Overlapping addresses not allowed' option ticked on the Address Types picklist, the record must not span any of the active dates of another record with that AddressType.

","urlObject":{"path":["Addresses"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"c855b0bd-b11f-807f-612d-1bc43b2765da","name":"Add an Employee's Address","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token","warning":""},{"key":"Content-Type","value":"application/json; charset=UTF-8","warning":""}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"100\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"AddressType\": \"Home\",\n\t\"AddressLine1\": \"24 First Street\"\n}"},"url":{"raw":"{{url}}/Addresses?$format=json","host":["{{url}}"],"path":["Addresses"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"content-length","key":"content-length","value":"631","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Thu, 24 Aug 2017 09:23:51 GMT","description":""},{"name":"location","key":"location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/Addresses(AddressLine1='24%20First%20Street',AddressType='Home',EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',PersonCode='100')","description":""},{"name":"status","key":"status","value":"201","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"642","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Addresses/@Element\",\n \"PersonCode\": \"100\",\n \"FullName\": null,\n \"Salutation\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"AddressType\": \"Home\",\n \"AddressLine1\": \"24 First Street\",\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"AddressLine4\": null,\n \"AddressLine5\": null,\n \"City\": null,\n \"County\": null,\n \"CountyCode\": null,\n \"Country\": null,\n \"PostCode\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-08-21T16:10:04.5383446Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"d3aa27e3-802c-ba0c-8fcd-6e5b451b82d9"},{"name":"Update an Employee's Address","id":"880f2ca8-c036-47e0-a9b3-8830eb5c140a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/Addresses(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', AddressType='[AddressType]', AddressLine1='[AddressLine1]')","description":"

This request will update an employee's Address Details record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom, AddressType and AddressLine1 cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Addresses(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', AddressType='[AddressType]', AddressLine1='[AddressLine1]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"880f2ca8-c036-47e0-a9b3-8830eb5c140a"},{"name":"Delete an Employee's Address","id":"a6354f52-87de-485b-491a-1e0acaa0452f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Addresses(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', AddressType='[AddressType]', AddressLine1='[AddressLine1]')","description":"

This request will delete an employee's Address Details record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

This API enables all information from the Addresses tab on the Contact Details screen for active and inactive employees to be retrieved and modified.

The identifying keys for Addresses are:

PersonCode
EffectiveFrom
AddressType
AddressLine1

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonGUID		Read-only.
PersonCode	Y	Key. Read-only.
FullName		Read-only.
Salutation		Read-only.
EffectiveFrom	Y	Key. Read-only.
EffectiveTo	Y
AddressType	Y	Key. Read-only.
AddressLine1	Y	Key. Read-only.
AddressLine2
AddressLine3
AddressLine4
AddressLine5
City
County
CountyCode
Country
PostCode
Comments
InsertUser		Read-only.
LastModifiedDate	Y	Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"0b01fb1b-3770-45ed-b657-477202ed1024","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b474fd60-f481-4fc4-b97e-1c2416659332","type":"text/javascript","exec":[""]}}],"_postman_id":"f38c855d-3d88-5125-9559-fd7a71ff7fd2"}],"id":"a9e95a17-9309-2d45-69e7-c44101f6c549","_postman_id":"a9e95a17-9309-2d45-69e7-c44101f6c549","description":""},{"name":"Bank Details","item":[{"name":"List of Employee Bank Details","id":"8dbc5008-816d-f5db-7e18-c2d963f07f62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"challengeAlgorithm":"","scope":"","grant_type":"","client_authentication":"","accessTokenUrl":"","accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/BankDetails?$format=json","description":"

This request will return a list of Employee Bank Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["BankDetails"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"5ed66244-1d0b-f204-6b4b-3fb7f769183c","name":"List of Employee Bank Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/BankDetails?$format=json","host":["{{url}}"],"path":["BankDetails"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"608","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 17 Jan 2018 17:39:18 GMT","name":"Date","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"408","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#BankDetails\",\n \"value\": [\n {\n \"PersonGUID\": \"e88bef01-7468-4e82-b510-4ff7075eb5bb\",\n \"PersonCode\": \"26\",\n \"FullName\": \"Cheryl Abrahams\",\n \"EffectiveFrom\": \"2013-01-01T00:00:00\",\n \"EffectiveTo\": \"2013-12-31T00:00:00\",\n \"BankName\": \"Bank 1\",\n \"AccountType\": \"Bank Account\",\n \"AccountHolder\": \"C Abrahams\",\n \"AccountNumber\": \"01584269\",\n \"SortCode\": \"445588\",\n \"RollNumber\": \"22\",\n \"IsForeign\": 1,\n \"BankWindow\": \"CC\",\n \"BICSwiftCode\": \"478\",\n \"IBAN\": \"7777\",\n \"Comments\": \"Note\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2014-04-23T14:59:03.59Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"8dbc5008-816d-f5db-7e18-c2d963f07f62"},{"name":"Add an Employee's Bank Details","id":"8f6356fc-b135-d7be-e9a9-126c14b1219b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2018-01-01T00:00:00\",\n \"BankName\": \"Bank 1\",\n \"AccountNumber\": \"12345678\",\n \"VerificationTypeCode\": \"UNKNOWN\"\n}"},"url":"{{url}}/BankDetails?$format=json","description":"

This request will insert a Bank Details record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
If the EffectiveTo is left blank, the system will try to insert the record with EffectiveTo set to Open Ended.
If the AddressType has the 'Overlapping addresses not allowed' option ticked on the Address Types picklist, the record must not span any of the active dates of another record with that AddressType.

","urlObject":{"path":["BankDetails"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"dff6ef80-ed19-9dbf-942c-ae9030517dda","name":"Add an Employee's Bank Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","type":"text","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2018-01-01T00:00:00\",\n\t\"BankName\": \"Bank 1\",\n\t\"AccountNumber\": \"12345678\",\n \"VerificationTypeCode\": \"UNKNOWN\"\n}"},"url":{"raw":"{{url}}/BankDetails?$format=json","host":["{{url}}"],"path":["BankDetails"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"554","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 03 Jan 2018 09:10:43 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/BankDetails(AccountNumber='12345678',EffectiveFrom=datetime'2018-01-01T00%3A00%3A00',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"470","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#BankDetails/@Element\",\n \"PersonGUID\": null,\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2018-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"BankName\": \"Bank 1\",\n \"AccountType\": null,\n \"AccountHolder\": null,\n \"AccountNumber\": \"12345678\",\n \"SortCode\": null,\n \"RollNumber\": null,\n \"IsForeign\": 0,\n \"BankWindow\": null,\n \"BICSwiftCode\": null,\n \"IBAN\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.5524509Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"VerificationTypeCode\": \"UNKNOWN\",\n \"VerfificationType\": \"None\",\n \"Verified\": 0,\n \"OverrideVerification\": 0\n}"}],"_postman_id":"8f6356fc-b135-d7be-e9a9-126c14b1219b"},{"name":"Update an Employee's Bank Details record","id":"1fb15dde-5f86-4385-9d65-ee536c585e3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/BankDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', AccountNumber='[AccountNumber]')","description":"

This request will update an employee's Bank Details record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom and AccountNumber cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["BankDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', AccountNumber='[AccountNumber]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1fb15dde-5f86-4385-9d65-ee536c585e3a"},{"name":"Delete an Employee's Bank Details record","id":"aa6d8175-0edf-4b02-0684-c5681b5f1880","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/BankDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', AccountNumber='[AccountNumber]')","description":"

This request will delete an employee's Bank Details record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

This API enables all information from the Bank Details screen for active and inactive employees to be retrieved and modified.
The identifying keys for Bank Details are:

PersonCode
EffectiveFrom
AccountNumber

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonGUID		Read-only.
PersonCode	Y	Key.
FullName		Read-only.
EffectiveFrom	Y	Key.
EffectiveTo	Y
BankName	Y
AccountType
AccountHolder
AccountNumber	Y	Key.
SortCode
RollNumber
IsForeign		1 = Ticked, 0 = Not Ticked.
BankWindow
BICSwiftCode
IBAN
Comments
InsertUser		Read-only.
LastModifiedDate	Y	Read-only.
LastModifiedUser		Read-only.
VerificationTypeCode		UNKNOWN = None, UK = UK & IRE - Sort Code & Acc. No., OTHER = IBAN
VerificationType
Verified		1 = Ticked, 0 = Not Ticked.
OverrideVerification		1 = Ticked, 0 = Not Ticked.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"ec5cfcc5-4dd7-4fcf-bad5-4caf65fd1477","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a96c188b-a354-4e4a-bf93-b2dca9bd8e95","type":"text/javascript","exec":[""]}}],"_postman_id":"0f534944-bb18-c04d-3fda-2551e1f7075e"},{"name":"Identification","item":[{"name":"Legal Idenitifers","item":[{"name":"List of Employee Legal Identifiers","id":"0a2e7281-5c29-1f0c-77ea-ff1617370758","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/LegalIdentifiers?$format=json","description":"

This request will return a list of Legal Identifiers from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["LegalIdentifiers"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"a067589b-2eec-f21e-153e-b06ee3182e6c","name":"List of Legal Identifiers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/LegalIdentifiers?$format=json","host":["{{url}}"],"path":["LegalIdentifiers"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"525","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 15:17:34 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"415","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#LegalIdentifiers\",\n \"value\": [\n {\n \"PersonGUID\": \"ee552c7c-9462-40t3-a2b7-ttrr6734a9fe\",\n \"PersonCode\": \"CEZ23\",\n \"FullName\": \"Margaret Gray\",\n \"EffectiveFrom\": \"2007-03-08T00:00:00\",\n \"EffectiveTo\": \"2008-03-08T00:00:00\",\n \"DocumentType\": \"Driving Licence\",\n \"Primary\": 0,\n \"NumberOrId\": \"ABC991-422JP\",\n \"Authority\": null,\n \"Jurisdiction\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:49:59.807Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"SettledStatus\": 1\n }\n ]\n}"}],"_postman_id":"0a2e7281-5c29-1f0c-77ea-ff1617370758"},{"name":"Add an Employee's Legal Identifier","id":"d50353c8-bfbf-fbd6-6608-b8a74b1b87f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\":\"26\",\n \"EffectiveFrom\":\"2017-01-01T00:00:00\",\n \"EffectiveTo\":\"2019-12-31T00:00:00\",\n \"DocumentType\":\"Passport\",\n \"Primary\":\"1\",\n \"NumberOrId\":\"12345678\"\n}"},"url":"{{url}}/LegalIdentifiers?$format=json","description":"

This request will insert a Legal Identifiers record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["LegalIdentifiers"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"4016645f-d0cf-f442-3874-1c2a3a1b9db0","name":"Add an Employee's Legal Identifier","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\":\"26\",\n\t\"EffectiveFrom\":\"2017-01-01T00:00:00\",\n\t\"EffectiveTo\":\"2019-12-31T00:00:00\",\n\t\"DocumentType\":\"Passport\",\n\t\"Primary\":\"1\",\n\t\"NumberOrId\":\"12345678\"\n}"},"url":{"raw":"{{url}}/LegalIdentifiers?$format=json","host":["{{url}}"],"path":["LegalIdentifiers"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"473","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 16:48:16 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/LegalIdentifiers(DocumentType='Passport',EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"519","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#LegalIdentifiers/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2019-12-31T00:00:00\",\n \"DocumentType\": \"Passport\",\n \"Primary\": 1,\n \"NumberOrId\": \"12345678\",\n \"Authority\": null,\n \"Jurisdiction\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:03.9117547Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"d50353c8-bfbf-fbd6-6608-b8a74b1b87f1"},{"name":"Update an Employee's Legal Identifier","id":"ecce2019-97e0-4d32-8da4-69a32bf816ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/LegalIdentifiers(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', DocumentType='[DocumentType]')","description":"

This request will update an employee's Legal Identifiers record in the system.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom and DocumentType cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["LegalIdentifiers(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', DocumentType='[DocumentType]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ecce2019-97e0-4d32-8da4-69a32bf816ed"},{"name":"Delete an Employee's Legal Identifier","id":"949a2c3c-3f4f-2a96-926b-5565a22ab8b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/LegalIdentifiers(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', DocumentType='[DocumentType]')","description":"

This request will delete an employee's Legal Identifiers record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Legal Identifiers tab on the Identification screen for active and inactive employees to be retrieved and modified.

The identifying keys for Legal Identifiers are:

PersonCode
EffectiveFrom
DocumentType

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonGUID		Read-only.
PersonCode	Y	Key. Read-only.
FullName		Read-only.
EffectiveFrom	Y	Key.
EffectiveTo	Y
DocumentType	Y	Key.
Primary	Y	1 = Ticked, 0 = Not Ticked.
NumberOrId	Y
Authority
Jurisdiction
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
SettledStatus		1 = Ticked, 0 = Not Ticked.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"d0f9ed0e-ee71-4ad3-8bf5-05bb1ca8f2df","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c91163c2-4c50-437b-a92f-eb6c9f83d996","type":"text/javascript","exec":[""]}}],"_postman_id":"f5b11e9e-8e7a-0934-1ba8-f0c5893a9820"},{"name":"Visa Details","item":[{"name":"List of Employee Visa Details","id":"72c970f8-ae99-8b1d-227f-b0ea46a4f688","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/VisaDetails?$format=json","description":"

This request will return a list of Visa Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["VisaDetails"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"644a783e-81c8-aa36-ba63-1dfd40beba37","name":"List of Employee Visa Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token]"}],"url":{"raw":"{{url}}/VisaDetails?$format=json","host":["{{url}}"],"path":["VisaDetails"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"635","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 16:23:28 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"439","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#VisaDetails\",\n \"value\": [\n {\n \"PersonCode\": \"CEZ23\",\n \"FullName\": \"Margaret Gray\",\n \"EffectiveFrom\": \"2001-02-02T00:00:00\",\n \"EffectiveTo\": \"2002-02-02T00:00:00\",\n \"Type\": \"Adopted Children\",\n \"Number\": \"0\",\n \"Country\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:49:59.887Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"VerifiedByFormattedName\": null,\n \"VerifiedByPersonID\": null,\n \"VerifiedDate\": null,\n \"CompanySponsored\": 0,\n \"Cost\": null,\n \"BaseCost\": null,\n \"CurrencyCode\": null,\n \"BaseCurrencyCode\": \"USD\"\n }\n ]\n}"}],"_postman_id":"72c970f8-ae99-8b1d-227f-b0ea46a4f688"},{"name":"Add an Employee's Visa Details","id":"f543f79f-96db-59c6-401a-93a474bba22e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"Type\": \"Tier 2 (General)\"\n}"},"url":"{{url}}/VisaDetails?$format=json","description":"

This request will insert a Visa Details record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["VisaDetails"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"09ba558c-65d8-0f46-65ee-8c804fb5325e","name":"Add an Employee's Visa Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2999-12-31T00:00:00\",\n\t\"Type\": \"Tier 2 (General)\"\n}"},"url":{"raw":"{{url}}/VisaDetails?$format=json","host":["{{url}}"],"path":["VisaDetails"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"594","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 16:52:41 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/VisaDetails(EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',PersonCode='26',Type='Tier%202%20(General)')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"299","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#VisaDetails/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"Type\": \"Tier 2 (General)\",\n \"Number\": null,\n \"Country\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:03.8961076Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"VerifiedByFormattedName\": null,\n \"VerifiedByPersonID\": null,\n \"VerifiedDate\": null,\n \"CompanySponsored\": 0,\n \"Cost\": null,\n \"BaseCost\": null,\n \"CurrencyCode\": null,\n \"BaseCurrencyCode\": null\n}"}],"_postman_id":"f543f79f-96db-59c6-401a-93a474bba22e"},{"name":"Update an Employee's Visa Details Record","id":"0491f5b0-0eed-4138-9d74-255d318b0ebe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/VisaDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFromDate]', Type='[Type]')","description":"

This request will update an employee's Visa Details record in the system.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFromDate and Type cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["VisaDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFromDate]', Type='[Type]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0491f5b0-0eed-4138-9d74-255d318b0ebe"},{"name":"Delete an Employee's Visa Details Record","id":"7284ad3d-2f50-da27-842c-0fddf45495ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/VisaDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFromDate]', Type='[Type]')","description":"

This request will delete an employee's Visa Details record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["VisaDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFromDate]', Type='[Type]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7284ad3d-2f50-da27-842c-0fddf45495ad"}],"id":"69a92a64-2b7d-5b79-b524-de33be432cd2","description":"

This API enables all information from the Visa Details tab on the Identifications screen for active and inactive employees to be retrieved and modified.

The identifying keys for Visa Details are:

PersonCode
EffectiveFrom
Type

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCode	Y	Key.
FullName		Read-only.
EffectiveFrom	Y	Key.
EffectiveTo	Y
Type	Y	Key.
Number
Country
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
VerifiedByFormattedName
VerifiedByPersonID
VerifiedDate
CompanySponsored		1 = Ticked, 0 = Not Ticked.
Cost
BaseCost		Read-only.
CurrencyCode
BaseCurrencyCode		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"f3c3569f-989a-4948-8f2a-49998049b48c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"15babf34-b5ad-48e2-91b4-ddcdeb269b70","type":"text/javascript","exec":[""]}}],"_postman_id":"69a92a64-2b7d-5b79-b524-de33be432cd2"},{"name":"Security Credentials","item":[{"name":"List of Employee Security Credentials","id":"b5c2a7bd-4c2e-4b61-a483-1ae67f62fcb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"tokenName":"","scope":"","accessTokenUrl":"","clientId":"","clientSecret":"","accessToken":"","tokenType":"","challengeAlgorithm":"","grant_type":"","client_authentication":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/SecurityCredentials?$format=json&$top=1","description":"

This request will return a list of Security Credentials from the system.

Notes:

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["SecurityCredentials"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"key":"$top","value":"1"}],"variable":[]}},"response":[{"id":"ff6567a6-baa7-4296-8504-eebf39ed7158","name":"List of Employee Visa Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token]"}],"url":{"raw":"{{url}}/VisaDetails?$format=json","host":["{{url}}"],"path":["VisaDetails"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"635","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 16:23:28 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"439","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#VisaDetails\",\n \"value\": [\n {\n \"PersonCode\": \"CEZ23\",\n \"FullName\": \"Margaret Gray\",\n \"EffectiveFrom\": \"2001-02-02T00:00:00\",\n \"EffectiveTo\": \"2002-02-02T00:00:00\",\n \"Type\": \"Adopted Children\",\n \"Number\": \"0\",\n \"Country\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:49:59.887Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"VerifiedByFormattedName\": null,\n \"VerifiedByPersonID\": null,\n \"VerifiedDate\": null,\n \"CompanySponsored\": 0,\n \"Cost\": null,\n \"BaseCost\": null,\n \"CurrencyCode\": null,\n \"BaseCurrencyCode\": \"USD\"\n }\n ]\n}"},{"id":"d75f4c25-dbb3-4533-90c5-5a739cfbbe74","name":"List of Employee Visa Details Copy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/SecurityCredentials?$format=json","host":["{{url}}"],"path":["SecurityCredentials"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Jun 2024 20:10:40 GMT"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"Content-Length","value":"575"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=68hbVkNWLYbs6hAqcw08ezfC4NSWqM9ZtVtwhb6b2RtSZiT7FsxC96joOkaZo7bXMh0WdgmMDrKYNhui6xllLTvQ9gFDhtTdBrHPQXiXerCaf7mc6Q8KXXKIqBwZ; Expires=Wed, 12 Jun 2024 20:10:39 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=68hbVkNWLYbs6hAqcw08ezfC4NSWqM9ZtVtwhb6b2RtSZiT7FsxC96joOkaZo7bXMh0WdgmMDrKYNhui6xllLTvQ9gFDhtTdBrHPQXiXerCaf7mc6Q8KXXKIqBwZ; Expires=Wed, 12 Jun 2024 20:10:39 GMT; Path=/; SameSite=None; Secure"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#SecurityCredentials\",\n \"value\": [\n {\n \"SecurityCredentialGuid\": \"bd66feb2-d0f4-40b1-9360-607332c806b5\",\n \"PersonGUID\": \"7ab6ef7a-43cd-472f-852a-bbee3992ad19\",\n \"PersonCode\": \"CEZ01\",\n \"FullName\": \"Cheryl Abrahams\",\n \"EffectiveFrom\": \"2024-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"Type\": \"Security Check\",\n \"Name\": \"C Abrahams\",\n \"IssueDate\": \"2024-06-05T00:00:00\",\n \"IssuingAuthority\": null,\n \"Comments\": null,\n \"InsertUser\": \"shawn.acker@omnicrom.com\",\n \"LastModifiedDate\": \"2024-06-05T20:08:45.907Z\",\n \"LastModifiedUser\": \"shawn.acker@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"b5c2a7bd-4c2e-4b61-a483-1ae67f62fcb1"},{"name":"Add an Employee's Security Credentials","id":"a7be6c97-57f2-482b-b713-407f45e4d2e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"tokenName":"","scope":"","accessTokenUrl":"","clientSecret":"","clientId":"","accessToken":"","tokenType":"","challengeAlgorithm":"","grant_type":"","client_authentication":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n \"SecurityCredentialGuid\": \"bd66feb2-d0f4-40b1-9360-607332c806b5\",\n \"PersonCode\": \"CEZ01\",\n \"EffectiveFrom\": \"2024-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"Type\": \"Security Check\",\n \"Name\": \"C Abrahams\"\n}"},"url":"{{url}}/SecurityCredentials?$format=json","description":"

This request will insert a Security Credentials record for an employee.

Notes:

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["SecurityCredentials"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"1c4fae11-cd98-439e-a37e-bf7db5754847","name":"Add an Employee's Visa Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2999-12-31T00:00:00\",\n\t\"Type\": \"Tier 2 (General)\"\n}"},"url":{"raw":"{{url}}/VisaDetails?$format=json","host":["{{url}}"],"path":["VisaDetails"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"594","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 16:52:41 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/VisaDetails(EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',PersonCode='26',Type='Tier%202%20(General)')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"299","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#VisaDetails/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"Type\": \"Tier 2 (General)\",\n \"Number\": null,\n \"Country\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:03.8961076Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"VerifiedByFormattedName\": null,\n \"VerifiedByPersonID\": null,\n \"VerifiedDate\": null,\n \"CompanySponsored\": 0,\n \"Cost\": null,\n \"BaseCost\": null,\n \"CurrencyCode\": null,\n \"BaseCurrencyCode\": null\n}"},{"id":"6f906605-4776-46e6-bcd0-f0661074be8a","name":"Add an Employee's Visa Details Copy","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n \"SecurityCredentialGuid\": \"bd66feb2-d0f4-40b1-9360-607332c806b5\",\n \"PersonCode\": \"CEZ01\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"Type\": \"Security Check\",\n \"Name\": \"C Abrahams\"\n}"},"url":{"raw":"{{url}}/SecurityCredentials?$format=json","host":["{{url}}"],"path":["SecurityCredentials"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Jun 2024 20:08:46 GMT"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"Content-Length","value":"529"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=LT6M8hkfMdIOxdcqMK1mbVOCcFm/5kZ3QxxZqs5QV6cLfOodruHxMJHfPSPF5pFVMKSqHgT4ZY2rgfChpl/3wfELz5upFvloUWF4QzCR/5WY7RSBx8u6HIQv/8Fi; Expires=Wed, 12 Jun 2024 20:08:45 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=LT6M8hkfMdIOxdcqMK1mbVOCcFm/5kZ3QxxZqs5QV6cLfOodruHxMJHfPSPF5pFVMKSqHgT4ZY2rgfChpl/3wfELz5upFvloUWF4QzCR/5WY7RSBx8u6HIQv/8Fi; Expires=Wed, 12 Jun 2024 20:08:45 GMT; Path=/; SameSite=None; Secure"},{"key":"Cache-Control","value":"no-cache"},{"key":"Location","value":"https://qaalb.cezanneondemand.com/COD_UPGRADE/v7/DataService.svc/SecurityCredentials(PersonCode='CEZ01',SecurityCredentialGuid=guid'bd66feb2-d0f4-40b1-9360-607332c806b5')"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#SecurityCredentials/@Element\",\n \"SecurityCredentialGuid\": \"bd66feb2-d0f4-40b1-9360-607332c806b5\",\n \"PersonGUID\": null,\n \"PersonCode\": \"CEZ01\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2024-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"Type\": \"Security Check\",\n \"Name\": \"C Abrahams\",\n \"IssueDate\": \"2024-06-05T00:00:00\",\n \"IssuingAuthority\": null,\n \"Comments\": null,\n \"InsertUser\": \"shawn.acker@omnicrom.com\",\n \"LastModifiedDate\": \"2024-06-05T19:52:17.8486353Z\",\n \"LastModifiedUser\": \"shawn.acker@omnicrom.com\"\n}"}],"_postman_id":"a7be6c97-57f2-482b-b713-407f45e4d2e3"},{"name":"Update an Employee's Security Credentials Record","id":"9d94e08c-bc7a-4ccc-afe1-632ed870b77b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"","scope":"","tokenName":"","clientSecret":"","clientId":"","accessToken":"","tokenType":"","challengeAlgorithm":"","grant_type":"","client_authentication":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/SecurityCredentials(PersonCode='[PersonCode]', SecurityCredentialGuid=guid'[SecurityCredentialGuid]'","description":"

This request will update an employee's Security Credentials record in the system.

Notes:

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only.
The PersonCode, EffectiveFromDate and Type cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["SecurityCredentials(PersonCode='[PersonCode]', SecurityCredentialGuid=guid'[SecurityCredentialGuid]'"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d94e08c-bc7a-4ccc-afe1-632ed870b77b"},{"name":"Delete an Employee's Security Credentials Record","id":"3846c879-bd83-48c5-b142-d0900519fabf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/SecurityCredentials(PersonCode='[PersonCode]', SecurityCredentialGuid=guid'[SecurityCredentialGuid]'","description":"

This request will delete an employee's Security Credentials record.

Notes:

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["SecurityCredentials(PersonCode='[PersonCode]', SecurityCredentialGuid=guid'[SecurityCredentialGuid]'"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3846c879-bd83-48c5-b142-d0900519fabf"}],"id":"1c7ec595-94e1-46ee-851c-7fe5959a329f","description":"

This API enables all information from the Security Credentials tab on the Identifications screen for active and inactive employees to be retrieved and modified.

The identifying keys for Security Credentials are:

PersonCode
SecurityCredentialGuid

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
SecurityCredentialGuid	Y	Key.
PersonGUID		Read-only.
PersonCode	Y	Key.
FullName		Read-only.
EffectiveFrom	Y
EffectiveTo	Y
Type
Name	Y
IssueDate
IssuingAuthority
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","_postman_id":"1c7ec595-94e1-46ee-851c-7fe5959a329f"}],"id":"73118f96-5455-a217-14cb-69423e37bb83","_postman_id":"73118f96-5455-a217-14cb-69423e37bb83","description":""},{"name":"Skills & Qualifications","item":[{"name":"Professional Qualifications","item":[{"name":"List of Employee Professional Qualifications","id":"c0d6b24d-9f3a-c701-c70b-3ce5934b6efc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/ProfessionalQualifications?$format=json","description":"

This request will return a list of Professional Qualifications from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["ProfessionalQualifications"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"f8ef6b49-bdba-7507-b191-d8cdfb6b7c6e","name":"List of Professional Qualifications","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/ProfessionalQualifications?$format=json","host":["{{url}}"],"path":["ProfessionalQualifications"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"702","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 16:17:21 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"418","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#ProfessionalQualifications\",\n \"value\": [\n {\n \"ProfessionalQualificationGUID\": \"d946e004-6c98-4bc5-893d-a35025a5e49e\",\n \"PersonCode\": \"0593\",\n \"FullName\": \"Laura Waterhouse\",\n \"StartDate\": \"2010-01-01T00:00:00\",\n \"CompletionDate\": \"2999-12-31T00:00:00\",\n \"RenewalDate\": null,\n \"Qualification\": \"Chartered Institute of Personnel Development\",\n \"GrantedBy\": null,\n \"Regulatory\": 0,\n \"CompanyFunded\": 0,\n \"CurrencyCode\": null,\n \"Cost\": null,\n \"BaseCost\": null,\n \"BaseCurrencyCode\": \"USD\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2013-01-30T09:38:47.913Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"c0d6b24d-9f3a-c701-c70b-3ce5934b6efc"},{"name":"Add an Employee's Professional Qualifications","id":"bdf7859a-5f4c-fb0c-ab76-3d45793893ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n \"ProfessionalQualificationGUID\": \"00000000-0000-0000-0000-000000000123\",\n \"PersonCode\": \"26\",\n \"StartDate\": \"2017-01-04T00:00:00\",\n \"CompletionDate\": \"2017-12-12T00:00:00\",\n \"Qualification\": \"Chartered Accountant ACA\"\n}"},"url":"{{url}}/ProfessionalQualifications?$format=json","description":"

This request will insert a Professional Qualification record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n
To add a new Professional Qualification, you need to enter a unique ProfessionalQualificationGUID for each new record in the following format: '12345678-1234-1234-1234-123456789101'\n

","urlObject":{"path":["ProfessionalQualifications"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"disabled":true,"key":"$filter","value":"PersonCode eq 26"}],"variable":[]}},"response":[{"id":"9aa77f63-6e0d-d257-dc95-44688cad52f2","name":"Add an Employee's Professional Qualifications","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n\t\"ProfessionalQualificationGUID\": \"00000000-0000-0000-0000-000000000123\",\n\t\"PersonCode\": \"26\",\n\t\"StartDate\": \"2017-01-04T00:00:00\",\n\t\"CompletionDate\": \"2017-12-12T00:00:00\",\n\t\"Qualification\": \"Chartered Accountant ACA\"\n}"},"url":{"raw":"{{url}}/ProfessionalQualifications?$format=json","host":["{{url}}"],"path":["ProfessionalQualifications"],"query":[{"key":"$format","value":"json"},{"key":"$filter","value":"PersonCode eq 26","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"638","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Mon, 08 Jan 2018 11:14:05 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/ProfessionalQualifications(PersonCode='26',ProfessionalQualificationGUID=guid'00000000-0000-0000-0000-000000000123')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"580","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#ProfessionalQualifications/@Element\",\n \"ProfessionalQualificationGUID\": \"00000000-0000-0000-0000-000000000123\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"StartDate\": \"2017-01-04T00:00:00\",\n \"CompletionDate\": \"2017-12-12T00:00:00\",\n \"RenewalDate\": null,\n \"Qualification\": \"Chartered Accountant ACA\",\n \"GrantedBy\": null,\n \"Regulatory\": 0,\n \"CompanyFunded\": 0,\n \"CurrencyCode\": null,\n \"Cost\": null,\n \"BaseCost\": null,\n \"BaseCurrencyCode\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:04.7242749Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"bdf7859a-5f4c-fb0c-ab76-3d45793893ef"},{"name":"Update an Employee's Professional Qualifications","id":"2805a83e-2038-4be4-8539-713dce4b938f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/ProfessionalQualifications(ProfessionalQualificationGUID=guid'[ProfessionalQualificationGUID]', PersonCode='[PersonCode]')","description":"

This request will update an employee's Professional Qualification record in the system.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The ProfessionalQualificationGUID and PersonCode cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["ProfessionalQualifications(ProfessionalQualificationGUID=guid'[ProfessionalQualificationGUID]', PersonCode='[PersonCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2805a83e-2038-4be4-8539-713dce4b938f"},{"name":"Delete an Employee's Professional Qualifications","id":"94029dea-80a2-7c01-c7d0-95acb8a3394d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ProfessionalQualifications(ProfessionalQualificationGUID=guid'[ProfessionalQualificationGUID]', PersonCode='[PersonCode]')","description":"

This request will delete a Professional Qualification record for an employee.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Professional Qualifications tab on the Skills & Qualifications screen for active and inactive employees to be retrieved and modified.

The identifying keys for Professional Qualifications are:

ProfessionalQualificationGUID
PersonCode

\n\n

Fields

\n\n

Field	Mandatory	Comments
ProfessionalQualificationGUID	Y	Key.
PersonCode	Y	Key.
FullName		Read-only.
StartDate	Y
CompletionDate	Y
RenewalDate
Qualification	Y
GrantedBy
Regulatory		1 = Ticked, 0 = Not Ticked.
CompanyFunded		1 = Ticked, 0 = Not Ticked.
CurrencyCode
Cost
BaseCost		Read-only.
BaseCurrencyCode		Read-only.
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"2f6caf91-a8e5-4d1b-86f8-d636b285e06a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"edcb5fa7-7362-4e42-9039-ff5b7fc53854","type":"text/javascript","exec":[""]}}],"_postman_id":"981e48a3-0f78-8342-fe74-82698db56a0f"},{"name":"Education","item":[{"name":"List of Employee Education Details","id":"c53d79c2-4de7-9cc4-1340-1f7c0f9928b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/EducationDetails?$format=json","description":"

This request will return a list of Education Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["EducationDetails"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"cdd70eff-3125-21cf-cdc1-8aac8da4eea0","name":"List of Education Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/EducationDetails?$format=json","host":["{{url}}"],"path":["EducationDetails"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"971","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 13:41:56 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"694","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#EducationDetails\",\n \"value\": [\n {\n \"PersonCode\": \"40\",\n \"EffectiveFrom\": \"2002-10-01T00:00:00\",\n \"Status\": \"Completed\",\n \"EffectiveTo\": \"2004-06-30T00:00:00\",\n \"Verified\": 0,\n \"Qualification\": \"Bsc Engineering\",\n \"SubjectMajor\": null,\n \"LevelClassification\": \"Bachelor's Degree\",\n \"ISCEDClassification\": \"First stage of tertiary education\",\n \"LocalClassification\": null,\n \"ExpectedDuration\": \"3\",\n \"Comments\": null,\n \"SchoolUniversity\": null,\n \"WebAddress\": null,\n \"SchoolType\": null,\n \"City\": null,\n \"CountyCode\": null,\n \"County\": null,\n \"Country\": null,\n \"PostCode\": null,\n \"Result\": null,\n \"OutOf\": null,\n \"AcademicHonour\": 0,\n \"HonourDescription\": null,\n \"AcademicCreditHours\": null,\n \"CreditHoursEarned\": null,\n \"CompanyFunded\": 0,\n \"Cost\": null,\n \"Currency\": null,\n \"BaseCost\": null,\n \"BaseCurrency\": \"USD\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2013-01-30T14:25:04.663Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"c53d79c2-4de7-9cc4-1340-1f7c0f9928b6"},{"name":"Add an Employee's Education Details","id":"3ba883fd-d754-adb6-f09a-d0ef7f245587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"Status\": \"In Progress\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"Verified\": \"1\",\n \"Qualification\": \"BA Management\"\n}"},"url":"{{url}}/EducationDetails?$format=json","description":"

This request will insert an Education record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["EducationDetails"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"c8d2716a-c068-390a-8159-7db58ea8d9e3","name":"Add an Employee's Education Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","disabled":false},{"key":"Content-Type","value":"application/json; charset=UTF-8","warning":"","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"Status\": \"In Progress\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"Verified\": \"1\",\n\t\"Qualification\": \"BA Management\"\n}"},"url":{"raw":"{{url}}/EducationDetails?$format=json","host":["{{url}}"],"path":["EducationDetails"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"891","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 17:12:23 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/EducationDetails(EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',PersonCode='26',Qualification='BA%20Management')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"389","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#EducationDetails/@Element\",\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"Status\": \"In Progress\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"Verified\": 1,\n \"Qualification\": \"BA Management\",\n \"SubjectMajor\": null,\n \"LevelClassification\": null,\n \"ISCEDClassification\": null,\n \"LocalClassification\": null,\n \"ExpectedDuration\": null,\n \"Comments\": null,\n \"SchoolUniversity\": null,\n \"WebAddress\": null,\n \"SchoolType\": null,\n \"City\": null,\n \"CountyCode\": null,\n \"County\": null,\n \"Country\": null,\n \"PostCode\": null,\n \"Result\": null,\n \"OutOf\": null,\n \"AcademicHonour\": 0,\n \"HonourDescription\": null,\n \"AcademicCreditHours\": null,\n \"CreditHoursEarned\": null,\n \"CompanyFunded\": 0,\n \"Cost\": null,\n \"Currency\": null,\n \"BaseCost\": null,\n \"BaseCurrency\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:04.0992756Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"3ba883fd-d754-adb6-f09a-d0ef7f245587"},{"name":"Update an Employee's Education Details","id":"abab4a06-52f3-4b50-bc70-3617072d215d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/EducationDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', Qualification='[Qualification]')","description":"

This request will update an Education record for an employee.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom and Qualification cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["EducationDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', Qualification='[Qualification]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"abab4a06-52f3-4b50-bc70-3617072d215d"},{"name":"Delete an Employee's Education Details","id":"a5c7c09c-ff28-9692-3069-fcaac6e72d3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/EducationDetails(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', Qualification='[Qualification]')","description":"

This request will delete an Education record for an employee.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Education tab on the Skills & Qualifications screen for active and inactive employees to be retrieved and modified.

The identifying keys for Education are:

PersonCode
EffectiveFrom
Qualification

\n\n

Fields

\n\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
EffectiveFrom	Y	Key. Read-only.
Status
EffectiveTo	Y
Verified	Y	1 = Ticked, 0 = Not Ticked.
Qualification	Y	Key. Read-only.
SubjectMajor
LevelClassification		Read-only.
ISCEDClassification		Read-only.
LocalClassification		Read-only.
ExpectedDuration
Comments
SchoolUniversity
WebAddress
SchoolType
City
CountyCode
County
Country
PostCode
Result
OutOf
AcademicHonour	Y	1 = Ticked, 0 = Not Ticked.
HonourDescription
AcademicCreditHours
CreditHoursEarned
CompanyFunded	Y	1 = Ticked, 0 = Not Ticked.
Cost
Currency
BaseCost		Read-only.
BaseCurrency		Read-only.
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"d3e38175-45f3-42b4-a855-59875da13145","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e57657e7-e041-4026-a4ef-d3cf0013f673","type":"text/javascript","exec":[""]}}],"_postman_id":"2c989f3e-c6ee-94e1-eb84-d5ac20b12f87"},{"name":"External Work History","item":[{"name":"List of Employees' External Work History","id":"e2512a69-c1d8-1f7c-d26f-b1964eb4bb1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/ExternalWorkHistory?$format=json","description":"

This request will return a list of External Work History from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["ExternalWorkHistory"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"dccc0657-7b39-f483-6148-2cb141fcde67","name":"List of External Work History","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token]"}],"url":{"raw":"{{url}}/ExternalWorkHistory?$format=json","host":["{{url}}"],"path":["ExternalWorkHistory"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"794","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 15:00:13 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"575","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#ExternalWorkHistory\",\n \"value\": [\n {\n \"PersonCode\": \"40\",\n \"FullName\": \"Aaron Cornel\",\n \"EffectiveFrom\": \"2006-01-01T00:00:00\",\n \"EffectiveTo\": \"2006-07-31T00:00:00\",\n \"Company\": \"Mars\",\n \"CompanyURL\": null,\n \"CompanySize\": null,\n \"JobTitle\": \"Intern\",\n \"CurrencyCode\": null,\n \"ReasonForLeaving\": null,\n \"GeographicArea\": null,\n \"FunctionalArea\": null,\n \"IndustrySector\": null,\n \"IndustryType\": null,\n \"CompanyCategory\": null,\n \"ContractualLevel\": null,\n \"Location\": null,\n \"Contract\": null,\n \"LeavingSalary\": null,\n \"BaseLeavingSalary\": null,\n \"Comments\": \"Worked in production support\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2012-12-21T16:13:05.543Z\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"BaseCurrencyCode\": \"USD\"\n }\n ]\n}"}],"_postman_id":"e2512a69-c1d8-1f7c-d26f-b1964eb4bb1a"},{"name":"Add an Employee's External Work History","id":"41b95fff-9db2-c904-1010-f18307cea787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2014-01-01T00:00:00\",\n \"EffectiveTo\": \"2015-03-15T00:00:00\",\n \"Company\": \"Company 1\",\n \"JobTitle\": \"Finance Director\"\n}"},"url":"{{url}}/ExternalWorkHistory?$format=json","description":"

This request will insert an External Work History record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["ExternalWorkHistory"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"c959593d-68b9-140a-c615-692efe491bea","name":"Add an Employee's External Work History","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2014-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2015-03-15T00:00:00\",\n\t\"Company\": \"Company 1\",\n\t\"JobTitle\": \"Finance Director\"\n}"},"url":{"raw":"{{url}}/ExternalWorkHistory?$format=json","host":["{{url}}"],"path":["ExternalWorkHistory"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"745","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 17:14:18 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/ExternalWorkHistory(EffectiveFrom=datetime'2014-01-01T00%3A00%3A00',EffectiveTo=datetime'2015-03-15T00%3A00%3A00',JobTitle='Finance%20Director',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"879","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#ExternalWorkHistory/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2014-01-01T00:00:00\",\n \"EffectiveTo\": \"2015-03-15T00:00:00\",\n \"Company\": \"Company 1\",\n \"CompanyURL\": null,\n \"CompanySize\": null,\n \"JobTitle\": \"Finance Director\",\n \"CurrencyCode\": null,\n \"ReasonForLeaving\": null,\n \"GeographicArea\": null,\n \"FunctionalArea\": null,\n \"IndustrySector\": null,\n \"IndustryType\": null,\n \"CompanyCategory\": null,\n \"ContractualLevel\": null,\n \"Location\": null,\n \"Contract\": null,\n \"LeavingSalary\": null,\n \"BaseLeavingSalary\": null,\n \"Comments\": null,\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:04.8492753Z\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"BaseCurrencyCode\": null\n}"}],"_postman_id":"41b95fff-9db2-c904-1010-f18307cea787"},{"name":"Update an Employee's External Work History","id":"1743d069-dd2b-4261-bf3f-03b88bf9bfe3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/ExternalWorkHistory(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', EffectiveTo=datetime'[EffectiveTo]', JobTitle='[JobTitle]')","description":"

This request will update an employee's External Work History record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom, EffectiveTo and JobTitle cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["ExternalWorkHistory(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', EffectiveTo=datetime'[EffectiveTo]', JobTitle='[JobTitle]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1743d069-dd2b-4261-bf3f-03b88bf9bfe3"},{"name":"Delete an Employee's External Work History","id":"c642c193-4770-334e-cb8d-b34e84125d8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/ExternalWorkHistory(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', EffectiveTo=datetime'[EffectiveTo]', JobTitle='[JobTitle]')","description":"

This request will delete an employee's External Work History record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the External Work History screen for active and inactive employees to be retrieved and modified.

The identifying keys for External Work History are:

PersonCode
EffectiveFrom
EffectiveTo
JobTitle

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
FullName		Read-only.
EffectiveFrom	Y	Key.
EffectiveTo	Y	Key.
Company	Y
CompanyURL
CompanySize
JobTitle	Y	Key.
CurrencyCode
ReasonForLeaving
GeographicArea
FunctionalArea
IndustrySector
IndustryType
CompanyCategory
ContractualLevel
Location
Contract
LeavingSalary
BaseLeavingSalary		Read-only.
Comments
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
InsertUser		Read-only.
BaseCurrencyCode		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"1cb0e47a-998b-4d49-9d83-3c46517f67ca","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2787c78b-9c0b-4e63-bca7-b5d198dcbd73","type":"text/javascript","exec":[""]}}],"_postman_id":"a8cbd8cb-a912-0970-56ca-c2287f77c5b8"},{"name":"Language Skills","item":[{"name":"List of Employee Language Skills","id":"7e027ab1-72d6-12c5-da29-e5514ddadadc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/LanguageSkills?$format=json","description":"

This request will return a list of Language Skills from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["LanguageSkills"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"3e64d36b-5743-b6d2-87c3-f6592c8aab59","name":"List of Language Skills","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/LanguageSkills?$format=json","host":["{{url}}"],"path":["LanguageSkills"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"596","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 15:12:57 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"513","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#LanguageSkills\",\n \"value\": [\n {\n \"PersonCode\": \"40\",\n \"FullName\": \"Aaron Cornel\",\n \"LanguageDescription\": \"Dutch\",\n \"ProficiencyLevel\": \"Medium\",\n \"LevelClassification\": null,\n \"DateAchieved\": \"2012-12-21T00:00:00\",\n \"Result\": null,\n \"Fluent\": 1,\n \"WrittenProficiency\": null,\n \"ReadingProficiency\": null,\n \"TranslationProficiency\": null,\n \"VerbalProficiency\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2013-01-30T14:33:43.963Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"7e027ab1-72d6-12c5-da29-e5514ddadadc"},{"name":"Add an Employee's Language Skills","id":"1d18c6f6-19e1-2439-82cf-8f35698e25e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"LanguageDescription\": \"French\",\n \"ProficiencyLevel\": \"High\"\n}"},"url":"{{url}}/LanguageSkills?$format=json","description":"

This request will insert a Language record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["LanguageSkills"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"9869f27d-90a9-c10c-ff5c-5f9cc2a10d87","name":"Add an Employee's Language Skills","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"LanguageDescription\": \"French\",\n\t\"ProficiencyLevel\": \"High\"\n}"},"url":{"raw":"{{url}}/LanguageSkills?$format=json","host":["{{url}}"],"path":["LanguageSkills"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"551","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 17:15:43 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/LanguageSkills(LanguageDescription='French',PersonCode='26',ProficiencyLevel='High')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"629","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#LanguageSkills/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"LanguageDescription\": \"French\",\n \"ProficiencyLevel\": \"High\",\n \"LevelClassification\": null,\n \"DateAchieved\": \"2017-12-16T00:00:00\",\n \"Result\": null,\n \"Fluent\": 0,\n \"WrittenProficiency\": null,\n \"ReadingProficiency\": null,\n \"TranslationProficiency\": null,\n \"VerbalProficiency\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:04.9117581Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"1d18c6f6-19e1-2439-82cf-8f35698e25e8"},{"name":"Update an Employee's Language Skills Record","id":"d459275e-b987-4785-b590-9e45f5962d42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/LanguageSkills(PersonCode='[PersonCode]', LanguageDescription='[LanguageDescription]', ProficiencyLevel='[ProficiencyLevel]')","description":"

This request will update an employee's Language Skills record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, LanguageDescription and ProficiencyLevel cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["LanguageSkills(PersonCode='[PersonCode]', LanguageDescription='[LanguageDescription]', ProficiencyLevel='[ProficiencyLevel]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d459275e-b987-4785-b590-9e45f5962d42"},{"name":"Delete an Employee's Language Skills Record","id":"c907d1e3-6f6f-f0c2-b2af-7e7443c27fe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/LanguageSkills(PersonCode='[PersonCode]', LanguageDescription='[LanguageDescription]', ProficiencyLevel='[ProficiencyLevel]')","description":"

This request will delete an employee's Language Skills record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Languages tab on the Skills & Qualifications screen for active and inactive employees to be retrieved and modified.

The identifying keys for Language Skills are:

PersonCode
LanguageDescription
ProficiencyLevel

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
FullName		Read-only.
LanguageDescription	Y	Key.
ProficiencyLevel	Y	Key.
LevelClassification
DateAchieved
Result
Fluent		1 = Ticked, 0 = Not Ticked.
WrittenProficiency
ReadingProficiency
TranslationProficiency
VerbalProficiency
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"8edf7e82-5566-43d1-b05c-d58a13d58c6c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5a2d94e5-c110-4bb3-92a4-bf7701b956e4","type":"text/javascript","exec":[""]}}],"_postman_id":"01d896f0-4941-94ec-2b22-c2959757eda9"},{"name":"Personal Skills","item":[{"name":"List of Employee Personal Skills","id":"77c8f897-62dd-2763-a491-5d4c833e901c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/PersonalSkills?$format=json","description":"

This request will return a list of Personal Skills from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["PersonalSkills"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"90fcfe09-b778-6787-afb6-82b5fe4fad0f","name":"List of Employee Personal Skills","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/PersonalSkills?$format=json","host":["{{url}}"],"path":["PersonalSkills"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"624","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 16:15:58 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"421","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PersonalSkills\",\n \"value\": [\n {\n \"PersonalSkillsGUID\": \"35d04256-8625-465c-9f7b-6946378ec48f\",\n \"PersonCode\": \"807678\",\n \"FullName\": \"Monday Bandele\",\n \"SkillDescription\": \"Communication\",\n \"Level\": \"High\",\n \"YearLastUsed\": null,\n \"YearsExperience\": null,\n \"InterestLevel\": \"High\",\n \"EvidenceType\": null,\n \"EvidenceName\": null,\n \"VerificationDate\": \"2017-07-31T00:00:00\",\n \"VerifiedBy\": null,\n \"EvidenceDescription\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-07-31T16:15:55.42Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"77c8f897-62dd-2763-a491-5d4c833e901c"},{"name":"Add an Employee's Personal Skills","id":"a94fa58e-85f8-c773-33ad-1ccc0a01421e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":"{\n \"PersonalSkillsGUID\": \"12345678-1234-1234-1234-123456789101\",\n \"PersonCode\": \"100\",\n \"SkillDescription\": \"Advanced Excel\"\n}"},"url":"{{url}}/PersonalSkills?$format=json","description":"

This request will insert a Personal Skills record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n
To add a new Personal Skill, you need to enter a unique PersonalSkillsGUID for each new record in the following format: '12345678-1234-1234-1234-123456789101'\n

","urlObject":{"path":["PersonalSkills"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"72ab87b4-7072-54f9-0eec-84e66df3d37f","name":"Add an Employee's Personal Skills","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":"{\n \"PersonalSkillsGUID\": \"12345678-1234-1234-1234-123456789101\",\n \"PersonCode\": \"100\",\n \"SkillDescription\": \"Advanced Excel\"\n}"},"url":{"raw":"{{url}}/PersonalSkills?$format=json","host":["{{url}}"],"path":["PersonalSkills"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"598","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Mon, 08 Jan 2018 12:13:44 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/PersonalSkills(PersonalSkillsGUID=guid'12345678-1234-1234-1234-123456789101',PersonCode='100')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"576","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PersonalSkills/@Element\",\n \"PersonalSkillsGUID\": \"12345678-1234-1234-1234-123456789101\",\n \"PersonCode\": \"100\",\n \"FullName\": null,\n \"SkillDescription\": \"Advanced Excel\",\n \"Level\": null,\n \"YearLastUsed\": null,\n \"YearsExperience\": null,\n \"InterestLevel\": null,\n \"EvidenceType\": null,\n \"EvidenceName\": null,\n \"VerificationDate\": \"2017-12-16T00:00:00\",\n \"VerifiedBy\": null,\n \"EvidenceDescription\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:04.7086502Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"a94fa58e-85f8-c773-33ad-1ccc0a01421e"},{"name":"Update an Employee's Personal Skills","id":"d35d2469-a6c1-4bdc-a15b-5c23d29865a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/PersonalSkills(PersonCode='[PersonCode]', SkillDescription='[SkillDescription]')","description":"

This request will update an employee's Personal Skills record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode and SkillDescription cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["PersonalSkills(PersonCode='[PersonCode]', SkillDescription='[SkillDescription]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d35d2469-a6c1-4bdc-a15b-5c23d29865a2"},{"name":"Delete an Employee's Personal Skills","id":"64bff75f-29ff-10c3-2d95-3fbea245e87f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/PersonalSkills(PersonCode='[PersonCode]', SkillDescription='[SkillDescription]')","description":"

This request will delete an employee's Personal Skills record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["PersonalSkills(PersonCode='[PersonCode]', SkillDescription='[SkillDescription]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"64bff75f-29ff-10c3-2d95-3fbea245e87f"}],"id":"c2cf04cb-5741-a672-00c8-4505e5f08718","description":"

This API enables all information from the Personal Skills tab on the Skills & Qualifications screen for active and inactive employees to be retrieved and modified.

The identifying keys for Personal Skills are:

PersonalSkillsGUID
PersonCode

\n\n

Fields

\n\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonalSkillsGUID	Y	Key.
PersonCode	Y	Key.
FullName		Read-only.
SkillDescription	Y
Level
YearLastUsed
YearsExperience
InterestLevel
EvidenceType
EvidenceName
VerificationDate
VerifiedBy
EvidenceDescription
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"c920f82d-dfa8-4e9f-afa9-74c7e03d1f06","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1efc6d2c-09ca-45df-82d2-6035018bcc35","type":"text/javascript","exec":[""]}}],"_postman_id":"c2cf04cb-5741-a672-00c8-4505e5f08718"},{"name":"Licences","item":[{"name":"List of Employee Licences","id":"40c88922-d360-6407-b2ac-3291556e3af7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Licences?$format=json","description":"

This request will return a list of Licences from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Licences"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"4654348d-7592-b455-0897-12774ebbf879","name":"List of Licences","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/Licences?$format=json","host":["{{url}}"],"path":["Licences"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"540","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 15:21:04 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"453","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Licences\",\n \"value\": [\n {\n \"PersonCode\": \"CEZ23\",\n \"FullName\": \"Margaret Gray\",\n \"EffectiveFrom\": \"2001-02-02T00:00:00\",\n \"EffectiveTo\": \"2002-02-02T00:00:00\",\n \"LicenceType\": \"Motor Vehicle Personal\",\n \"Status\": null,\n \"Name\": \"License Name\",\n \"IssueDate\": \"2011-07-28T00:00:00\",\n \"IssuingAuthority\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:49:59.917Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"40c88922-d360-6407-b2ac-3291556e3af7"},{"name":"Add an Employee's Licences","id":"450e8682-e693-d912-6b17-179a4f747633","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"LicenceType\": \"Certified Public Accountant\",\n \"Name\": \"Accountancy\"\n}"},"url":"{{url}}/Licences?$format=json","description":"

This request will insert a Licences record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Licences"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"85d6e3e3-4f80-f024-8360-e7281c851dad","name":"Add an Employee's Licences","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"LicenceType\": \"Certified Public Accountant\",\n \"Name\": \"Accountancy\"\n}"},"url":{"raw":"{{url}}/Licences?$format=json","host":["{{url}}"],"path":["Licences"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"503","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 17:20:12 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/Licences(EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',EffectiveTo=datetime'2017-12-31T00%3A00%3A00',LicenceType='Certified%20Public%20Accountant',Name='Accountancy',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"429","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Licences/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"LicenceType\": \"Certified Public Accountant\",\n \"Status\": null,\n \"Name\": \"Accountancy\",\n \"IssueDate\": \"2017-12-16T00:00:00\",\n \"IssuingAuthority\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:04.9430082Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"450e8682-e693-d912-6b17-179a4f747633"},{"name":"Update an Employee's Licences Record","id":"191c5679-7463-4194-aa21-75bccf94ec45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/Licences(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', EffectiveTo=datetime'[EffectiveTo]', LicenceType='[LicenceType]', Name='[Name]')","description":"

This request will update an employee's Licences record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom, EffectiveTo, LicenceType and Name cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Licences(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', EffectiveTo=datetime'[EffectiveTo]', LicenceType='[LicenceType]', Name='[Name]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"191c5679-7463-4194-aa21-75bccf94ec45"},{"name":"Delete an Employee's Licences Record","id":"da8bd9bc-5bc7-8098-3206-ae8ef5d6252b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/Licences(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', EffectiveTo=datetime'[EffectiveTo]', LicenceType='[LicenceType]', Name='[Name]')","description":"

This request will delete an employee's Licences record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Licences tab on the Skills & Qualifications screen for active and inactive employees to be retrieved and modified.

The identifying keys for Licences are:

PersonCode
EffectiveFrom
EffectiveTo
LicenceType
Name

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonCode	Y	Key.
FullName		Read-only.
EffectiveFrom	Y	Key.
EffectiveTo	Y	Key.
LicenceType	Y	Key.
Status
Name	Y	Key.
IssueDate
IssuingAuthority
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"a0fea27a-b8aa-4413-9569-f97e8febb516","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c0ec5b58-996a-4717-b841-275401c4f79b","type":"text/javascript","exec":[""]}}],"_postman_id":"6edc56f1-c82d-a341-9c93-a8a243793411"}],"id":"09a2bdd5-c990-0b56-62cb-ba5a93ca2835","_postman_id":"09a2bdd5-c990-0b56-62cb-ba5a93ca2835","description":""},{"name":"Employment","item":[{"name":"Calendar Assignment","item":[{"name":"List of Employee Calendar Assignments","id":"c9a4fecb-76fe-4401-ab77-730042243822","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/CalendarAssignment?$format=json","description":"

This request will return a list of Calendar Assignments from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["CalendarAssignment"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"disabled":true,"key":"$top","value":"1"}],"variable":[]}},"response":[],"_postman_id":"c9a4fecb-76fe-4401-ab77-730042243822"},{"name":"Add an Employee Calendar Assignment","id":"a013f61f-fb31-4eb4-afd8-9e898d143c7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":"{\n\t\"AbsenceCalendar\": \"England & Wales Calendar Holiday\",\n\t\"PersonCode\": \"0029\",\n\t\"StartDate\": \"2006-03-19T00:00:00\",\n \"EndDate\": \"2999-12-31T00:00:00\"\n}"},"url":"{{url}}/CalendarAssignment?$format=json","description":"

This request will insert a Calendar Assignment record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["CalendarAssignment"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"43f00839-2d25-48ee-939a-e467c5e8b3b6","name":"Add an Employee Calendar Assignment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"AbsenceCalendar\": \"England & Wales Calendar Holiday\",\n\t\"PersonCode\": \"0029\",\n\t\"StartDate\": \"2006-03-19T00:00:00\",\n \"EndDate\": \"2999-12-31T00:00:00\"\n}"},"url":{"raw":"{{url}}/CalendarAssignment?$format=json","host":["{{url}}"],"path":["CalendarAssignment"],"query":[{"key":"$format","value":"json"},{"key":"$top","value":"1","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"450","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":"Custom header"},{"key":"Date","value":"Fri, 01 Jun 2018 15:49:27 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Location","value":"https://qa.cezanneondemand.com/COD_UPGRADE/v2/DataService.svc/CalendarAssignment(AbsenceCalendar='England%20%26%20Wales%20Calendar%20Holiday',PersonCode='0029',StartDate=datetime'2006-03-19T00%3A00%3A00')","name":"Location","description":"Used in redirection, or when a new resource has been created."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#CalendarAssignment/@Element\",\n \"AbsenceCalendar\": \"England & Wales Calendar Holiday\",\n \"BusinessStartTime\": \"1900-01-01T00:00:00\",\n \"BusinessEndTime\": \"1900-01-01T23:59:00\",\n \"PersonCode\": \"0029\",\n \"FullName\": null,\n \"StartDate\": \"2006-03-19T00:00:00\",\n \"EndDate\": \"2999-12-31T00:00:00\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2018-06-01T15:13:29.484788Z\"\n}"}],"_postman_id":"a013f61f-fb31-4eb4-afd8-9e898d143c7d"},{"name":"Update an Employee's Calendar Assignment","id":"0296291e-4125-491a-ab9d-430b313e8ce0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"StartDate\": \"2020-01-01T00:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/CalendarAssignment(AbsenceCalendar='[AbsenceCalendar]', PersonCode='[PersonCode]', StartDate=datetime'[StartDate]')","description":"

This request will update an employee's Calendar Assignment record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The AbsenceCalendar, PersonCode and StartDate cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["CalendarAssignment(AbsenceCalendar='[AbsenceCalendar]', PersonCode='[PersonCode]', StartDate=datetime'[StartDate]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0296291e-4125-491a-ab9d-430b313e8ce0"},{"name":"Delete an Employee's Calendar Assignment","id":"010a9e04-a66c-4a7f-a64a-191a39606d92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/CalendarAssignment(AbsenceCalendar='[AbsenceCalendar]', PersonCode='[PersonCode]', StartDate=datetime'[StartDate]')","description":"

This request will delete an employee's Calendar Assignment record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Employee Calendar Assignments screen for active and inactive employees to be retrieved and modified.

The identifying key for Calendar Assignments is:

AbsenceCalendar
PersonCode
StartDate

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
AbsenceCalendar	Y	Key. Read-only.
BusinessStartTime		Key. Read-only.
BusinessEndTime
PersonCode	Y	Key. Read-only.
FullName
StartDate	Y
EndDate	Y
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"2d27ac10-a156-4e69-a931-c0104bb4d458","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e52c4d15-8bbd-43e6-a929-e2de5a371960","type":"text/javascript","exec":[""]}}],"_postman_id":"677316ff-c44c-45ec-83f2-02e015854b11"},{"name":"Employments","item":[{"name":"List of Employee Employment Details","id":"634250d2-a7fd-c3b2-55c2-32b4bf8cf10c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Employments?$format=json","description":"

This request will return a list of Employment Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Employments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"bcad9c93-ef9c-f045-2268-072510cbf0d6","name":"List of Employment Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/Employments?$format=json","host":["{{url}}"],"path":["Employments"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1444","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 14:57:00 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"936","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Employments\",\n \"value\": [\n {\n \"EmploymentGUID\": \"db162c7c-7526-40a1-a4a3-ebbb5043a6fe\",\n \"PersonGUID\": \"ee552c7c-9462-40t3-a2b7-ttrr6734a9fe\",\n \"PersonCode\": \"H807661\",\n \"FullName\": \"Karl Fletcher\",\n \"HireDate\": \"2015-05-12T00:00:00\",\n \"TerminationDate\": \"2015-09-02T00:00:00\",\n \"EmploymentID\": \"11111\",\n \"CompanyGUID\": \"2b7f5d5e-966f-41bc-a6dc-c7b9f604d8e8\",\n \"CompanyCode\": \"OMUK\",\n \"Company\": \"Omnicrom UK\",\n \"PrimaryEmployment\": 1,\n \"EmploymentReason\": null,\n \"HiringSource\": null,\n \"OriginalHireDate\": \"2015-05-12T00:00:00\",\n \"LengthOfService\": \"0.25\",\n \"LengthOfServiceYears\": 0,\n \"LengthOfServiceMonths\": 3,\n \"AdjustedHireDate\": null,\n \"ContinuousService\": \"0.25\",\n \"ContinuousServiceYears\": 0,\n \"ContinuousServiceMonths\": 3,\n \"DutyEntryDate\": null,\n \"WorkingTimeOptOut\": 0,\n \"WorkingTimeOptOutDate\": null,\n \"HiringComments\": null,\n \"ProbationPeriodTo\": null,\n \"ProbationPeriod\": null,\n \"ProbationPeriodTimeUnits\": null,\n \"ProbationStatus\": null,\n \"ProbationExtendedTo\": null,\n \"NoticePeriod\": null,\n \"NoticePeriodTimeUnits\": null,\n \"TerminationReason\": null,\n \"TimeUntilLeaving\": 0,\n \"LastWorkedDate\": null,\n \"LastPaidDate\": null,\n \"NoticeGivenDate\": null,\n \"IntendedRetirementDate\": null,\n \"TerminationComments\": null,\n \"RedundancyDateStatementSent\": null,\n \"RedundancyNumberofPaidWeeks\": null,\n \"RedundancyPaymentCurrency\": null,\n \"BaseCurrency\": null,\n \"StatutoryPaymentDue\": null,\n \"ActualPayment\": null,\n \"StatutoryPaymentDueBaseCurrency\": null,\n \"ActualPaymentBaseCurrency\": null,\n \"RedundancyComments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2015-09-03T13:41:55.387Z\",\n \"UseForPayroll\": 0,\n \"PayrollCode\": null,\n \"AdjustedHireDateYear\": null,\n \"HireDateYear\": 2015,\n \"OriginalHireDateYear\": 2015,\n \"AdjustedHireDateMonth\": null,\n \"HireDateMonth\": \"May\",\n \"OriginalHireDateMonth\": \"May\",\n \"InformHmrcOfCodeChange\": 0,\n \"PreviousPayrollCode\": null,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n }\n ]\n}"}],"_postman_id":"634250d2-a7fd-c3b2-55c2-32b4bf8cf10c"},{"name":"Add an Employee's Employment Details","id":"d5ac4657-20bd-378b-6f53-bd2662bb715b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"HireDate\": \"2017-07-19T00:00:00\",\n \"TerminationDate\": \"2999-12-31T00:00:00\",\n \"EmploymentID\": \"EMP00001\",\n \"CompanyCode\": \"OMUK\"\n}"},"url":"{{url}}/Employments?$format=json","description":"

This request will insert an Employment Details record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Employments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"bab9da71-8248-23d0-0cb9-729bad4b2a6f","name":"Add an Employee's Employment Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"HireDate\": \"2017-07-19T00:00:00\",\n \"TerminationDate\": \"2999-12-31T00:00:00\",\n \"EmploymentID\": \"EMP00001\",\n \"CompanyCode\": \"OMUK\"\n}"},"url":{"raw":"{{url}}/Employments?$format=json","host":["{{url}}"],"path":["Employments"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"1407","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 17:22:35 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/Employments(EmploymentID='EMP00001',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"451","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Employments/@Element\",\n \"EmploymentGUID\": \"db162c7c-7526-40a1-a4a3-ebbb5043a6fe\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"HireDate\": \"2017-07-19T00:00:00\",\n \"TerminationDate\": \"2999-12-31T00:00:00\",\n \"EmploymentID\": \"EMP00001\",\n \"CompanyGUID\": null,\n \"CompanyCode\": \"OMUK\",\n \"Company\": null,\n \"PrimaryEmployment\": 1,\n \"EmploymentReason\": null,\n \"HiringSource\": null,\n \"OriginalHireDate\": null,\n \"LengthOfService\": null,\n \"LengthOfServiceYears\": null,\n \"LengthOfServiceMonths\": null,\n \"AdjustedHireDate\": null,\n \"ContinuousService\": null,\n \"ContinuousServiceYears\": null,\n \"ContinuousServiceMonths\": null,\n \"DutyEntryDate\": null,\n \"WorkingTimeOptOut\": 0,\n \"WorkingTimeOptOutDate\": null,\n \"HiringComments\": null,\n \"ProbationPeriodTo\": null,\n \"ProbationPeriod\": null,\n \"ProbationPeriodTimeUnits\": null,\n \"ProbationStatus\": null,\n \"ProbationExtendedTo\": null,\n \"NoticePeriod\": null,\n \"NoticePeriodTimeUnits\": null,\n \"TerminationReason\": null,\n \"TimeUntilLeaving\": null,\n \"LastWorkedDate\": null,\n \"LastPaidDate\": null,\n \"NoticeGivenDate\": null,\n \"IntendedRetirementDate\": null,\n \"TerminationComments\": null,\n \"RedundancyDateStatementSent\": null,\n \"RedundancyNumberofPaidWeeks\": null,\n \"RedundancyPaymentCurrency\": null,\n \"BaseCurrency\": null,\n \"StatutoryPaymentDue\": null,\n \"ActualPayment\": null,\n \"StatutoryPaymentDueBaseCurrency\": null,\n \"ActualPaymentBaseCurrency\": null,\n \"RedundancyComments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.3805799Z\",\n \"UseForPayroll\": 0,\n \"PayrollCode\": null,\n \"AdjustedHireDateYear\": null,\n \"HireDateYear\": 2015,\n \"OriginalHireDateYear\": 2015,\n \"AdjustedHireDateMonth\": null,\n \"HireDateMonth\": \"May\",\n \"OriginalHireDateMonth\": \"May\",\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n}"}],"_postman_id":"d5ac4657-20bd-378b-6f53-bd2662bb715b"},{"name":"Update an Employee's Employment Details Record","id":"b71192d3-ffc3-4941-a23e-fbefd540910f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"HiringComments\": \"Example Comments\"\n}"},"url":"{{url}}/Employments(EmploymentID='[EmploymentID]', PersonCode='[PersonCode]')","description":"

This request will update an employee's Employment Details record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The EmploymentID and PersonCode cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Employments(EmploymentID='[EmploymentID]', PersonCode='[PersonCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b71192d3-ffc3-4941-a23e-fbefd540910f"},{"name":"Delete an Employee's Employment Details Record","id":"31c293f9-d61c-d580-90eb-1d904f351f33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/Employments(EmploymentID='[EmploymentID]', PersonCode='[PersonCode]')","description":"

This request will delete an employee's Employment Details record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

The Employments API enables all information from the Employment Details screen for active and inactive employees to be retrieved and modified.

The identifying keys for Employments are:

EmploymentID
PersonCode

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
EmploymentGUID	Y
PersonGUID		Read-only.
PersonCode	Y	Key. Read-only.
FullName		Read-only.
HireDate	Y
TerminationDate	Y
EmploymentID	Y	Key. Read-only.
CompanyGUID		Read-only.
CompanyCode	Y
Company
PrimaryEmployment		1 = Ticked, 0 = Not Ticked.
EmploymentReason
HiringSource
OriginalHireDate
LengthOfService		Read-only.
LengthOfServiceYears		Read-only.
LengthOfServiceMonths		Read-only.
AdjustedHireDate
ContinuousService		Read-only.
ContinuousServiceYears		Read-only.
ContinuousServiceMonths		Read-only.
DutyEntryDate
WorkingTimeOptOut		1 = Ticked, 0 = Not Ticked.
WorkingTimeOptOutDate
HiringComments
ProbationPeriodTo
ProbationPeriod
ProbationPeriodTimeUnits
ProbationStatus
ProbationExtendedTo
NoticePeriod
NoticePeriodTimeUnits
TerminationReason
TimeUntilLeaving
LastWorkedDate
LastPaidDate
NoticeGivenDate
IntendedRetirementDate
TerminationComments
RedundancyDateStatementSent
RedundancyNumberofPaidWeeks
RedundancyPaymentCurrency
BaseCurrency		Read-only.
StatutoryPaymentDue
ActualPayment
StatutoryPaymentDueBaseCurrency		Read-only.
ActualPaymentBaseCurrency		Read-only.
RedundancyComments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
UseForPayroll		1 = Ticked, 0 = Not Ticked.
PayrollCode
AdjustedHireDateYear		Read-only.
RegrettableLeaver		1 = Ticked, 0 = Not Ticked.
HireDateYear		Read-only.
WouldRehire		1 = Ticked, 0 = Not Ticked.
OriginalHireDateYear		Read-only.
AdjustedHireDateMonth		Read-only.
HireDateMonth		Read-only.
OriginalHireDateMonth		Read-only.
InformHmrcOfCodeChange		1 = Ticked, 0 = Not Ticked.
PreviousPayrollCode
ExitInterviewDate
FreeCheckbox1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeRichText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText4		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText5		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"6920a44a-894f-4d13-b93d-355606786f38","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4216b132-c2cc-4582-9dc2-fedbcfa1238c","type":"text/javascript","exec":[""]}}],"_postman_id":"f747ba73-d816-e955-063b-afc56155d58b"},{"name":"Employment Status","item":[{"name":"List of Employee Employment Status","id":"74f332ca-fef5-174b-c0f7-181e39eb6a30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/EmploymentStatus?$format=json","description":"

This request will return a list of Employment Status from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["EmploymentStatus"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"1dc98aee-b7aa-3ac1-0f15-37d6629e4f16","name":"List of Employee Employment Statuses","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/EmploymentStatus?$format=json","host":["{{url}}"],"path":["EmploymentStatus"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"448","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 14:43:42 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"406","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#EmploymentStatus\",\n \"value\": [\n {\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2016-11-28T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"EmploymentStatusReason\": \"Retiree\",\n \"ChangeReason\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2016-12-01T15:00:08.473Z\",\n \"ExcludeFromHeadcounts\": 0,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n }\n ]\n}"}],"_postman_id":"74f332ca-fef5-174b-c0f7-181e39eb6a30"},{"name":"Add an Employee's Employment Status","id":"a77c38f4-7edc-d584-11b3-450dbb22c0a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"EmploymentStatusReason\": \"Leave\",\n \"ExcludeFromHeadcounts\": \"1\"\n}"},"url":"{{url}}/EmploymentStatus?$format=json","description":"

This request will insert an Employment Status record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["EmploymentStatus"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"c3db12e9-4b96-9bfb-ef08-90a55cd33989","name":"Add an Employee's Employment Status","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"EmploymentStatusReason\": \"Leave\",\n\t\"ExcludeFromHeadcounts\": \"1\"\n}"},"url":{"raw":"{{url}}/EmploymentStatus?$format=json","host":["{{url}}"],"path":["EmploymentStatus"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"437","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 17:24:18 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/EmploymentStatus(EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',EmploymentStatusReason='Leave',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"585","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#EmploymentStatus/@Element\",\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"EmploymentStatusReason\": \"Leave\",\n \"ChangeReason\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.4118234Z\",\n \"ExcludeFromHeadcounts\": 1,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n}"}],"_postman_id":"a77c38f4-7edc-d584-11b3-450dbb22c0a5"},{"name":"Update an Employee's Employment Status Record","id":"c83c5f51-ecf0-48e6-9801-18745db3649c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/EmploymentStatus(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', EmploymentStatusReason='[EmploymentStatusReason]')","description":"

This request will update an employee's Employment Status record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom and EmploymentStatusReason cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["EmploymentStatus(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', EmploymentStatusReason='[EmploymentStatusReason]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c83c5f51-ecf0-48e6-9801-18745db3649c"},{"name":"Delete an Employee's Employment Status Record","id":"cfce9116-1875-a2ac-3553-03632b6e4a9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/EmploymentStatus(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', EmploymentStatusReason='[EmploymentStatusReason]')","description":"

This request will delete an employee's Employment Status record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Employment Status screen for active and inactive employees to be retrieved and modified through this API.

The identifying keys for Employment Status are:

PersonCode
EffectiveFrom
EmploymentStatusReason

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCode	Y	Key.
EffectiveFrom	Y	Key.
EffectiveTo	Y
EmploymentStatusReason	Y	Key.
ChangeReason
Comments
InsertUser
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
ExcludeFromHeadcounts	Y	1 = Ticked, 0 = Not Ticked.
FreeCheckbox1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeRichText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText4		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText5		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"e0c0553b-af63-441a-93b0-ff6972e49778","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4b470e7c-fbfd-42bb-998e-67279a8c65e8","type":"text/javascript","exec":[""]}}],"_postman_id":"e2ff895f-680e-b8db-4385-84f1df637eea"},{"name":"Employment Contracts","item":[{"name":"List of Employee Contracts","id":"8480d0fc-baac-24a9-4945-a1f4d1f583a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/EmploymentContracts?$format=json","description":"

This request will return a list of Employee Contracts from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["EmploymentContracts"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"e0bcf32d-b847-7e81-0fcb-0a6ac830c66b","name":"List of Employee Contracts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/EmploymentContracts?$format=json","host":["{{url}}"],"path":["EmploymentContracts"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"605","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 14:40:56 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"903","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#EmploymentContracts\",\n \"value\": [\n {\n \"PersonGUID\": \"0c62d13f-49da-4f8d-97db-92bf2511b582\",\n \"PersonCode\": \"L0589\",\n \"EmploymentID\": \"L0589\",\n \"EmploymentPrimaryEmployment\": 1,\n \"EffectiveFrom\": \"2000-01-03T00:00:00\",\n \"EffectiveTo\": \"2001-11-16T00:00:00\",\n \"EmploymentGUID\": \"b400983a-1443-4b2e-a0c3-d13112dde256\",\n \"ContractTermCode\": \"T1\",\n \"ContractTerm\": \"Full Time\",\n \"IsEmployee\": 1,\n \"ContractNameCode\": \"C2\",\n \"ContractName\": \"Standard\",\n \"PayrollSchedule\": null,\n \"PayrollGroup\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T14:57:54.023Z\"\n }\n ]\n}"}],"_postman_id":"8480d0fc-baac-24a9-4945-a1f4d1f583a3"},{"name":"Add an Employee's Employment Contract","id":"dfeb0bd4-c63f-dc64-5fae-2e4646dfa590","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EmploymentID\": \"EMP00001\",\n \"EffectiveFrom\": \"2017-07-19T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\"\n}"},"url":"{{url}}/EmploymentContracts?$format=json","description":"

This request will insert an Employment Contract record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["EmploymentContracts"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"e040274c-5488-2505-2303-d9b8adfeff74","name":"Add an Employee's Employment Contract","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EmploymentID\": \"EMP00001\",\n\t\"EffectiveFrom\": \"2017-07-19T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\"\n}"},"url":{"raw":"{{url}}/EmploymentContracts?$format=json","host":["{{url}}"],"path":["EmploymentContracts"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"565","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 17:32:56 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/EmploymentContracts(EffectiveFrom=datetime'2017-07-19T00%3A00%3A00',EmploymentID='EMP00001',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"478","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#EmploymentContracts/@Element\",\n \"PersonGUID\": null,\n \"PersonCode\": \"26\",\n \"EmploymentID\": \"EMP00001\",\n \"EmploymentPrimaryEmployment\": 1,\n \"EffectiveFrom\": \"2017-07-19T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"EmploymentGUID\": null, \n \"ContractTermCode\": null,\n \"ContractTerm\": null,\n \"IsEmployee\": 0,\n \"ContractNameCode\": null,\n \"ContractName\": null,\n \"PayrollSchedule\": null,\n \"PayrollGroup\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.4118234Z\"\n}"}],"_postman_id":"dfeb0bd4-c63f-dc64-5fae-2e4646dfa590"},{"name":"Update an Employee's Employment Contract","id":"86daa3fd-5e25-4812-b9f9-449185d39ad6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/EmploymentContracts(PersonCode='[PersonCode]', EmploymentID='[EmploymentID]', EffectiveFrom=datetime'[EffectiveFrom]')","description":"

This request will update an employee's Employment Contract record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EmploymentID and EffectiveFrom cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["EmploymentContracts(PersonCode='[PersonCode]', EmploymentID='[EmploymentID]', EffectiveFrom=datetime'[EffectiveFrom]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"86daa3fd-5e25-4812-b9f9-449185d39ad6"},{"name":"Delete an Employee's Employment Contract","id":"533a4cdb-c318-d21d-d3fa-85b5c18f66a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/EmploymentContracts(PersonCode='[PersonCode]', EmploymentID='[EmploymentID]', EffectiveFrom=datetime'[EffectiveFrom]')","description":"

This request will delete an employee's Employment Contract record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Contract History tab on the Employment Details screen for active and inactive employees to be retrieved and modified.

The unique keys for Employment Contracts are:

PersonCode
EmploymentID
EffectiveFrom

\n\n

Field	Mandatory	Comments
PersonGUID		Read-only.
PersonCode	Y	Key. Read-only.
EmploymentID	Y	Key. Read-only.
EmploymentPrimaryEmployment
EffectiveFrom	Y	Key. Read-only.
EffectiveTo	Y
EmploymentGUID		Read-only.
ContractTermCode
ContractTerm
IsEmployee		Read-only. 1 = Ticked, 0 = Not Ticked.
ContractNameCode
ContractName		Read-only.
PayrollSchedule
PayrollGroup
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"ba14edfd-4a66-49f4-9d86-97628ed11b8d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"55e37afb-a71b-42cb-bcc7-01a5a92e4417","type":"text/javascript","exec":[""]}}],"_postman_id":"d35167e2-c404-4969-7440-1e123e5fd8e9"},{"name":"SMCR","item":[{"name":"List of Employee SMCR Records","id":"8a9a7686-e9e8-453e-9831-5bb5f6fdf3a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"clientSecret":"","clientId":"","challengeAlgorithm":"","scope":"","grant_type":"","client_authentication":"","accessTokenUrl":"","tokenType":"","headerPrefix":"","tokenName":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/SMCR?$format=json","description":"

This request will return a list of SMCR records from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["SMCR"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"df838a75-7cda-4d9a-a31f-235a3e6c370a","name":"List of Employee SMCR Records","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/SMCR?$format=json","host":["{{url}}"],"path":["SMCR"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Sep 2021 16:29:41 GMT"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"Content-Length","value":"1608"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=XOJDDAKNj6gTarZCy12rzpBdtyOP0BMNW1gUWcCtJNqzrf01aNSW03cNV0IrLlHDHjFWp9yiESlmMR7XaNJqkfzE2FVSFue8JrZ6r+2iYeF3SQH93b1NJ6PneUiC; Expires=Thu, 07 Oct 2021 16:29:35 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=XOJDDAKNj6gTarZCy12rzpBdtyOP0BMNW1gUWcCtJNqzrf01aNSW03cNV0IrLlHDHjFWp9yiESlmMR7XaNJqkfzE2FVSFue8JrZ6r+2iYeF3SQH93b1NJ6PneUiC; Expires=Thu, 07 Oct 2021 16:29:35 GMT; Path=/; SameSite=None; Secure"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"https://w3.cezanneondemand.com/cezanneondemand/v5/DataService.svc/$metadata#SMCR\",\n \"value\": [\n {\n \"PersonGuid\": \"5ab5ef7a-43cd-345f-852a-bbee6666ad72\",\n \"SMCRCertificateGuid\": \"4444c07b-37dc-41d9-t754-88743da81bde\",\n \"EffectiveFromDate\": \"2021-09-23T00:00:00\",\n \"EffectiveToDate\": \"2022-09-23T00:00:00\",\n \"Fitness&ProprietaryAssessmentCompleted\": 1,\n \"NextFitness&ProprietaryAssessmentDate\": \"2022-09-01T00:00:00\",\n \"DeclarationSigned\": 1,\n \"DeclarationRenewalDate\": \"2022-09-02T00:00:00\",\n \"Comments\": \"Prescribed Responsibilities include:\\n\\n- Responsibility for the firm's performance of its obligations under the senior management regime.\\n- Responsibility for compliance with the requirements of the regulatory system about the management responsibilities map.\\n- Responsibility for overseeing the adoption of the firm's culture in the day-to-day management of the firm.\\n- Responsibility for the development and maintenance of the firm's business model by the governing body.\\n\\nOverall Responsibilities:\\n\\n- Responsibility for estate management, including facilities.\\n- Responsibility for corporate social responsibility, including equality and diversity.\",\n \"Type\": \"Senior Manager\",\n \"OrgUnitPosition\": \"BRD (CHAIR) - Chairman of the Board\",\n \"ImportKey\": \"20210923CEZ01SMF1SMCRCERTIFICATESdZ2NPvyyy3uEnBiIzxRFdeEpj5r66KK\",\n \"PositionCode\": \"CHAIR\",\n \"OrgUnitPositionEffectiveFrom\": \"2007-01-01T00:00:00\",\n \"PersonCode\": \"CEZ01\",\n \"IsPrimaryDeployment\": 1,\n \"SeniorManagerFunctionCode\": \"SMF1\",\n \"SeniorManagerFunction\": \"SMF1 - Chief Executive Function\",\n \"CertificationFunction\": null,\n \"CertificationFunctionCode\": null,\n \"OrgUnitCode\": \"BRD\"\n }\n ]\n}"}],"_postman_id":"8a9a7686-e9e8-453e-9831-5bb5f6fdf3a8"},{"name":"Add an Employee's SMCR Record","id":"fe773718-346f-4ff4-b33c-a0d237db1930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"clientId":"","clientSecret":"","accessToken":"","tokenType":"","challengeAlgorithm":"","scope":"","grant_type":"","client_authentication":"","accessTokenUrl":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n \"PersonCode\": \"CEZ01\",\n \"SMCRCertificateGuid\": \"6037c07b-37dc-41d9-b868-73344da81bdf\",\n \"EffectiveFromDate\": \"2023-09-24T00:00:00\",\n \"EffectiveToDate\": \"2024-09-23T00:00:00\",\n \"Type\": \"Senior Manager\",\n \"PositionCode\": \"CHAIR\",\n \"OrgUnitPositionEffectiveFrom\": \"2007-01-01T00:00:00\",\n \"SeniorManagerFunctionCode\": \"SMF1\",\n \"SeniorManagerFunction\": \"SMF1 - Chief Executive Function\",\n \"OrgUnitCode\": \"BRD\"\n }"},"url":"{{url}}/SMCR?$format=json","description":"

This request will insert an SMCR record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["SMCR"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"92c0c5a2-2876-413d-a9e0-1ff31794de7b","name":"Add an Employee's Employment Contract Copy","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n \"PersonCode\": \"CEZ01\",\n \"SMCRCertificateGuid\": \"6037c07b-37dc-41d9-b868-73344da81bdf\",\n \"EffectiveFromDate\": \"2023-09-24T00:00:00\",\n \"EffectiveToDate\": \"2024-09-23T00:00:00\",\n \"Type\": \"Senior Manager\",\n \"PositionCode\": \"CHAIR\",\n \"OrgUnitPositionEffectiveFrom\": \"2007-01-01T00:00:00\",\n \"SeniorManagerFunctionCode\": \"SMF1\",\n \"SeniorManagerFunction\": \"SMF1 - Chief Executive Function\",\n \"OrgUnitCode\": \"BRD\"\n }"},"url":{"raw":"https://w3.cezanneondemand.com/cezanneondemand/v5/dataservice.svc/SMCR?$format=json","protocol":"https","host":["w3","cezanneondemand","com"],"path":["cezanneondemand","v5","dataservice.svc","SMCR"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Sep 2021 16:53:07 GMT"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"Content-Length","value":"784"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=U7YYkXPPNF7gFOBXcWERgLCR8Mp6iUXaz6EdRoutru2VRdXQO7uNyZmVh/bpp/JspmAZw26cTnZexVWArHL0ArO0RKgOOo1IA7MPW42Rp7ZhTSKKVO4CZj2IM7/V; Expires=Thu, 07 Oct 2021 16:53:07 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=U7YYkXPPNF7gFOBXcWERgLCR8Mp6iUXaz6EdRoutru2VRdXQO7uNyZmVh/bpp/JspmAZw26cTnZexVWArHL0ArO0RKgOOo1IA7MPW42Rp7ZhTSKKVO4CZj2IM7/V; Expires=Thu, 07 Oct 2021 16:53:07 GMT; Path=/; SameSite=None; Secure"},{"key":"Cache-Control","value":"no-cache"},{"key":"Location","value":"https://qaalb.cezanneondemand.com/COD_F033B/v5/DataService.svc/SMCR(guid'6037c07b-37dc-41d9-b868-73344da81bdf')"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"https://w3.cezanneondemand.com/cezanneondemand/v5/DataService.svc/$metadata#SMCR/@Element\",\n \"PersonGuid\": null,\n \"SMCRCertificateGuid\": \"6037c07b-37dc-41d9-b868-73344da81bdf\",\n \"EffectiveFromDate\": \"2023-09-24T00:00:00\",\n \"EffectiveToDate\": \"2024-09-23T00:00:00\",\n \"Fitness&ProprietaryAssessmentCompleted\": 0,\n \"NextFitness&ProprietaryAssessmentDate\": null,\n \"DeclarationSigned\": 0,\n \"DeclarationRenewalDate\": null,\n \"Comments\": null,\n \"Type\": \"Senior Manager\",\n \"OrgUnitPosition\": null,\n \"ImportKey\": null,\n \"PositionCode\": \"CHAIR\",\n \"OrgUnitPositionEffectiveFrom\": \"2007-01-01T00:00:00\",\n \"PersonCode\": \"CEZ01\",\n \"IsPrimaryDeployment\": 1,\n \"SeniorManagerFunctionCode\": \"SMF1\",\n \"SeniorManagerFunction\": \"SMF1 - Chief Executive Function\",\n \"CertificationFunction\": null,\n \"CertificationFunctionCode\": null,\n \"OrgUnitCode\": \"BRD\"\n}"}],"_postman_id":"fe773718-346f-4ff4-b33c-a0d237db1930"},{"name":"Update an Employee's SMCR Record","id":"2d673b5d-1820-4f1a-b863-88e9c6f12eb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/EmploymentContracts(SMCRCertificateGuid='[SMCRCertificateGuid]')","description":"

This request will update an employee's SMCR record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["EmploymentContracts(SMCRCertificateGuid='[SMCRCertificateGuid]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d673b5d-1820-4f1a-b863-88e9c6f12eb1"},{"name":"Delete an Employee's SMCR Record","id":"fd198a8f-2b41-45ee-9f32-621a49b5fd50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/SMCR(SMCRCertificateGuid='[SMCRCertificateGuid]')","description":"

This request will delete an employee's SMCR record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["SMCR(SMCRCertificateGuid='[SMCRCertificateGuid]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd198a8f-2b41-45ee-9f32-621a49b5fd50"}],"id":"69c9a7e9-2958-4e13-ade7-0c7d4f49510a","description":"

This API enables all information from the SMCR screen for active and inactive employees to be retrieved and modified.

The unique keys for SMCR:

SMCRCertificateGuid

\n\n

Field	Mandatory	Comments
PersonGuid	Y	Read-only.
SMCRCertificateGuid	Y	Key. Read-only.
EffectiveFromDate	Y
EffectiveToDate	Y
Fitness&ProprietaryAssessmentCompleted		1 = Ticked, 0 = Not Ticked.
NextFitness&ProprietaryAssessmentDate
DeclarationSigned		1 = Ticked, 0 = Not Ticked.
DeclarationRenewalDate
Comments
Type
OrgUnitPosition
ImportKey
PositionCode
OrgUnitPositionEffectiveFrom
PersonCode		Read-only.
IsPrimaryDeployment
SeniorManagerFunctionCode
SeniorManagerFunction
CertificationFunction
CertificationFunctionCode
OrgUnitCode

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","_postman_id":"69c9a7e9-2958-4e13-ade7-0c7d4f49510a"},{"name":"National Contract Salary Levels (Read-Only)","item":[{"name":"List of National Contract Salary Levels","id":"702ea822-a611-71c8-a02a-e9ca5cd05e55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/NationalContractSalaryLevels?$format=json","description":"

This request will return a list of National Contract Salary Levels from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["NationalContractSalaryLevels"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"a93f3fee-1da6-75a5-9df7-db93e152e8de","name":"List of National Contract Salary Levels","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/NationalContractSalaryLevels?$format=json","host":["{{url}}"],"path":["NationalContractSalaryLevels"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"660","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Wed, 26 Jul 2017 16:02:31 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"464","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#NationalContractSalaryLevels\",\n \"value\": [\n {\n \"PersonCode\": \"26\",\n \"FullName\": \"Cheryl Abrahams\",\n \"EmploymentID\": \"EMP0001\",\n \"SalaryLevelCompanyCode\": \"OMHOLD\",\n \"SalaryLevelCompanyName\": \"Omnicrom Holding Ltd\",\n \"ContractualSalaryLevel\": \"Manager\",\n \"ContractualSalaryLevelCode\": \"A1\",\n \"CCNL\": \"Collective Bargaining Agreement\",\n \"CCNLCode\": \"21\",\n \"EffectiveFrom\": \"2006-01-01T00:00:00\",\n \"EffectiveTo\": \"2006-02-01T00:00:00\",\n \"SalaryLevelReason\": \"565656545646\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2015-12-23T10:39:29.837Z\"\n }\n ]\n}"}],"_postman_id":"702ea822-a611-71c8-a02a-e9ca5cd05e55"}],"id":"64546845-4906-41fc-1419-f80d6cc73139","description":"

This API enables all information from the Salary Levels tab on the National Contract Details screen for active and inactive employees to be retrieved and modified.

The identifying keys for National Contract Salary Levels are:

PersonCode
EmploymentID
ContractualSalaryLevel
EffectiveFrom

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
FullName		Read-only.
EmploymentID	Y	Key. Read-only.
SalaryLevelCompanyCode		Read-only.
SalaryLevelCompanyName		Read-only.
ContractualSalaryLevel	Y	Key. Read-only.
ContractualSalaryLevelCode		Read-only.
CCNL		Read-only.
CCNLCode		Read-only.
EffectiveFrom	Y	Key. Read-only.
EffectiveTo	Y	Read-only.
SalaryLevelReason		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to everyone within the system.
Restricted HR Professional	Has read-only access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"54096227-22bc-4828-a0e9-ee0c3ad22c1d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"00d63778-9c53-40fe-8461-07c5b4a6f19d","type":"text/javascript","exec":[""]}}],"_postman_id":"64546845-4906-41fc-1419-f80d6cc73139"},{"name":"National Contract Qualifications","item":[{"name":"List of Employee National Contract Qualifications","id":"a7688e2d-050f-42a1-1f12-a2068d9a1443","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/NationalContractQualifications?$format=json","description":"

This request will return a list of National Contract Qualifications from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["NationalContractQualifications"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"4efe3917-3497-027f-2536-d3d6f8f96814","name":"List of National Contract Qualifications","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/NationalContractQualifications?$format=json","host":["{{url}}"],"path":["NationalContractQualifications"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"647","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 15:32:27 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"440","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#NationalContractQualifications\",\n \"value\": [\n {\n \"PersonCode\": \"26\",\n \"FullName\": \"Cheryl Abrahams\",\n \"EmploymentID\": \"EMP0001\",\n \"QualificationCompanyCode\": \"OMHOLD\",\n \"QualificationCompanyName\": \"Omnicrom Holding Ltd\",\n \"Qualification\": \"Blue Collar\",\n \"QualificationCode\": \"O\",\n \"EffectiveFrom\": \"2016-12-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"DirectManufacturing\": 1,\n \"NationalContractReason\": null,\n \"NationalContractReasonCode\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2016-12-01T14:58:03.223Z\"\n }\n ]\n}"}],"_postman_id":"a7688e2d-050f-42a1-1f12-a2068d9a1443"},{"name":"Add an Employee's National Contract Qualifications","id":"7fa0c303-8a7e-d326-f469-d61389978732","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EmploymentID\": \"EMP00001\",\n \"Qualification\": \"Manager\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"DirectManufacturing\": \"0\"\n}"},"url":"{{url}}/NationalContractQualifications?$format=json","description":"

This request will insert a National Contract Qualification record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["NationalContractQualifications"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"4084679b-5f7a-d930-2b4e-0d40676329bd","name":"Add an Employee's National Contract Qualifications","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EmploymentID\": \"EMP00001\",\n\t\"Qualification\": \"Manager\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"DirectManufacturing\": \"0\"\n}"},"url":{"raw":"{{url}}/NationalContractQualifications?$format=json","host":["{{url}}"],"path":["NationalContractQualifications"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"601","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 17:37:28 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/NationalContractQualifications(EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',EmploymentID='EMP00001',PersonCode='26',Qualification='Manager')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"1133","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#NationalContractQualifications/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EmploymentID\": \"EMP00001\",\n \"QualificationCompanyCode\": null,\n \"QualificationCompanyName\": null,\n \"Qualification\": \"Manager\",\n \"QualificationCode\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"DirectManufacturing\": 0,\n \"NationalContractReason\": null,\n \"NationalContractReasonCode\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:04.1305245Z\"\n}"}],"_postman_id":"7fa0c303-8a7e-d326-f469-d61389978732"},{"name":"Update an Employee's National Contract Qualifications record","id":"dc916f72-f717-430a-82f9-3f5fec3f44c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"NationalContractReason\": \"Example Reason\"\n}"},"url":"{{url}}/NationalContractQualifications(PersonCode='[PersonCode]', EmploymentID='[EmploymentID]', Qualification='[Qualification]', EffectiveFrom=datetime'[EffectiveFrom]')","description":"

This request will update an employee's National Contract Qualification record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EmploymentID, Qualification and EffectiveFrom cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["NationalContractQualifications(PersonCode='[PersonCode]', EmploymentID='[EmploymentID]', Qualification='[Qualification]', EffectiveFrom=datetime'[EffectiveFrom]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc916f72-f717-430a-82f9-3f5fec3f44c6"},{"name":"Delete an Employee's National Contract Qualifications record","id":"b21f2a86-7f53-2172-01f8-67e80a812ab3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/NationalContractQualifications(PersonCode='[PersonCode]', EmploymentID='[EmploymentID]', Qualification='[Qualification]', EffectiveFrom=datetime'[EffectiveFrom]')","description":"

This request will delete an employee's National Contract Qualification record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Qualifications tab on the National Contract Details screen for active and inactive employees to be retrieved and modified.

The identifying keys for National Contract Qualifications are:

PersonCode
EmploymentID
Qualification
EffectiveFrom

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
FullName		Read-only.
EmploymentID	Y	Key.
QualificationCompanyCode		Read-only.
QualificationCompanyName		Read-only.
Qualification	Y	Key.
QualificationCode
EffectiveFrom	Y	Key.
EffectiveTo	Y
DirectManufacturing	Y	1 = Ticked, 0 = Not Ticked.
NationalContractReason
NationalContractReasonCode
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"99624faa-ad31-4ffa-9d9d-0788aa467fb6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b48180a5-90a3-4334-8f68-737d5edfa976","type":"text/javascript","exec":[""]}}],"_postman_id":"b3df190c-4ed4-eb59-aaa2-d1a92e28e23d"}],"id":"5bd7ba33-608c-f9ae-2abc-523d10733a25","_postman_id":"5bd7ba33-608c-f9ae-2abc-523d10733a25","description":""},{"name":"Deployment","item":[{"name":"Person Grades","item":[{"name":"List of Person Grades","id":"1cf28a71-094b-b4f0-e966-532554762f45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/PersonGrades?$format=json","description":"

This request will return a list of Person Grades from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["PersonGrades"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"dd27afe3-b830-0ce6-4749-29dd84db91a9","name":"List of Person Grades","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/PersonGrades?$format=json","host":["{{url}}"],"path":["PersonGrades"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"530","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 15:42:06 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"581","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PersonGrades\",\n \"value\": [\n {\n \"PersonGradeGUID\": \"db162c7c-7526-40a1-a4a3-ebbb5043a6fe\",\n \"PersonCode\": \"8925\",\n \"FullName\": \"Richard Harrison\",\n \"EffectiveFrom\": \"2000-01-08T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"PrimaryGrade\": 1,\n \"Comments\": null,\n \"DeploymentReason\": null,\n \"DeploymentReasonCode\": null,\n \"Grade\": \"24\",\n \"GradeCode\": \"24\",\n \"GradeGroup\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T15:15:09.037Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"GradeEmploymentID\": null\n }\n ]\n}"}],"_postman_id":"1cf28a71-094b-b4f0-e966-532554762f45"},{"name":"Add an Employee's Person Grade","id":"812cc955-05b4-65b3-6d95-9d1edfe9ec88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"PrimaryGrade\": \"1\",\n \"Grade\": \"Grade 6\",\n \"GradeCode\": \"Grade 6\"\n}"},"url":"{{url}}/PersonGrades?$format=json","description":"

This request will insert a Person Grade record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["PersonGrades"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"a36bf455-a70f-7036-4fe8-6da097554d5a","name":"Add an Employee's Person Grade","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"PrimaryGrade\": \"1\",\n\t\"Grade\": \"Grade 6\",\n\t\"GradeCode\": \"Grade 6\"\n}"},"url":{"raw":"{{url}}/PersonGrades?$format=json","host":["{{url}}"],"path":["PersonGrades"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"497","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Tue, 02 Jan 2018 17:39:10 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/PersonGrades(EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',GradeCode='Grade%206',PersonCode='26',PrimaryGrade=1)","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"676","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PersonGrades/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"PrimaryGrade\": 1,\n \"Comments\": null,\n \"DeploymentReason\": null,\n \"DeploymentReasonCode\": null,\n \"Grade\": \"Grade 6\",\n \"GradeCode\": \"Grade 6\",\n \"GradeGroup\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.8961782Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"812cc955-05b4-65b3-6d95-9d1edfe9ec88"},{"name":"Update an Employee's Person Grade record","id":"a2a3927a-e7be-4da1-8346-ecb728db21fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/PersonGrades(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', PrimaryGrade='[PrimaryGrade]', GradeCode='[GradeCode]')","description":"

This request will update an employee's Person Grade record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom, PrimaryGrade and GradeCode cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["PersonGrades(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', PrimaryGrade='[PrimaryGrade]', GradeCode='[GradeCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2a3927a-e7be-4da1-8346-ecb728db21fa"},{"name":"Delete an Employee's Person Grade record","id":"505f5af2-3521-11fc-ceac-d9dc0838ab01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/PersonGrades(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', PrimaryGrade='[PrimaryGrade]', GradeCode='[GradeCode]')","description":"

This request will delete an employee's Person Grade record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Person Deployment Grades screen for active and inactive employees to be retrieved and modified.

The identifying key for Person Grades is:

PersonGradeGUID

\n\n

Note:

For API v1 to v4, the identifying keys for Person Grades are:\n

PersonCode
EffectiveFrom
PrimaryGrade
GradeCode

\n\n

Fields

\n\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonGradeGUID	Y	Key.Read-only.
PersonCode	Y	Read-only.
FullName		Read-only.
EffectiveFrom	Y
EffectiveTo	Y
PrimaryGrade	Y
Comments
DeploymentReason
DeploymentReasonCode
Grade	Y
GradeCode	Y
GradeGroup
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
GradeEmploymentID

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"f850195d-1a43-448d-ac75-d5cfd7cd3200","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"672b2c1c-0f59-44b0-84c2-0e6e8dc8b6d4","type":"text/javascript","exec":[""]}}],"_postman_id":"2be9eb13-87d0-58e0-338e-fefb007a819f"},{"name":"Location Deployments","item":[{"name":"List of Employee Location Deployments","id":"fb9506a8-58af-e56a-9a73-ba15ed235add","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/dataservice.svc/LocationDeployments?$format=json","description":"

This request will return a list of Employee Location Deployments from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["dataservice.svc","LocationDeployments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"69a8039c-586d-1acd-dd26-7d3aba91e12c","name":"List of Employee Location Deployments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/LocationDeployments?$format=json","host":["{{url}}"],"path":["LocationDeployments"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"599","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 15:23:21 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"485","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#LocationDeployments\",\n \"value\": [\n {\n \"CompanyLocationCode\": \"Bristol\",\n \"CompanyLocationName\": \"Bristol\",\n \"EffectiveFrom\": \"2000-02-02T00:00:00\",\n \"EffectiveTo\": \"2003-04-22T00:00:00\",\n \"PersonCode\": \"L0595\",\n \"FormattedName\": \"Gurdip Raffa\",\n \"PrimaryLocation\": 1,\n \"DeploymentReason\": null,\n \"DeploymentReasonCode\": null,\n \"LocationWorkingTimePercentage\": \"100.00\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T15:11:35.227Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"fb9506a8-58af-e56a-9a73-ba15ed235add"},{"name":"Add an Employee's Location Deployment","id":"c1b02fa2-f5f6-f3f8-5473-56792668d952","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CompanyLocationName\": \"Derby\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"PersonCode\": \"26\"\n}"},"url":"{{url}}/LocationDeployments?$format=json","description":"

This request will insert a Location record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["LocationDeployments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"793c3534-ce79-0121-0a7c-f313170462ac","name":"Add an Employee's Location Deployment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"CompanyLocationName\": \"Derby\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"PersonCode\": \"26\"\n}"},"url":{"raw":"{{url}}/LocationDeployments?$format=json","host":["{{url}}"],"path":["LocationDeployments"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"548","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 03 Jan 2018 08:39:25 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/LocationDeployments(CompanyLocationName='Derby',EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"3752","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#LocationDeployments/@Element\",\n \"CompanyLocationCode\": null,\n \"CompanyLocationName\": \"Derby\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"PersonCode\": \"26\",\n \"FormattedName\": null,\n \"PrimaryLocation\": 1,\n \"DeploymentReason\": null,\n \"DeploymentReasonCode\": null,\n \"LocationWorkingTimePercentage\": \"100\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.833699Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"c1b02fa2-f5f6-f3f8-5473-56792668d952"},{"name":"Update an Employee's Location Deployment record","id":"39734ace-10c5-4524-b42e-c7dab9cbae0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/LocationDeployments(CompanyLocationName='[CompanyLocationName]', EffectiveFrom=datetime'[EffectiveFrom]', PersonCode='[PersonCode]')","description":"

This request will update an employee's Location record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The CompanyLocationName, EffectiveFrom and PersonCode cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["LocationDeployments(CompanyLocationName='[CompanyLocationName]', EffectiveFrom=datetime'[EffectiveFrom]', PersonCode='[PersonCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"39734ace-10c5-4524-b42e-c7dab9cbae0b"},{"name":"Delete an Employee's Location Deployment record","id":"c9a8b236-0267-0446-813e-02521a31d8b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/LocationDeployments(CompanyLocationName='[CompanyLocationName]', EffectiveFrom=datetime'[EffectiveFrom]', PersonCode='[PersonCode]')","description":"

This request will delete an employee's Location record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Location screen for active and inactive employees to be retrieved and modified.

The identifying keys for Location Deployments are:

CompanyLocationName
EffectiveFrom
PersonCode

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
CompanyLocationCode
CompanyLocationName	Y	Key.
EffectiveFrom	Y	Key.
EffectiveTo	Y
PersonCode	Y	Key.
FormattedName		Read-only.
PrimaryLocation		1 = Ticked, 0 = Not Ticked.
DeploymentReason
DeploymentReasonCode
LocationWorkingTimePercentage
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"ea62a910-4163-4362-9789-892b5f956088","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ce3e6286-d4c6-4ebe-afca-97badd8d3d98","type":"text/javascript","exec":[""]}}],"_postman_id":"6eba7f4c-7985-5b45-3b4c-e82664978dbf"},{"name":"Job Deployments","item":[{"name":"List of Job Deployments","id":"bf372d7f-c32a-37af-cd50-6defdd79318f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/JobDeployments?$format=json","description":"

This request will return a list of Employee Job Deployments from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["JobDeployments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"00691f3c-cfd7-673d-7d3b-922dd36c4b3b","name":"List of Job Deployments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/JobDeployments?$format=json","host":["{{url}}"],"path":["JobDeployments"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"574","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 15:06:22 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"452","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#JobDeployments\",\n \"value\": [\n {\n \"PersonCode\": \"CEZ50\",\n \"FullName\": \"Roger Fullwood\",\n \"EffectiveFrom\": \"2007-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"PrimaryJobDeployment\": 1,\n \"Comments\": null,\n \"DeploymentReason\": \"New Hire\",\n \"DeploymentReasonCode\": \"DR1\",\n \"JobDeploymentEmploymentGUID\": \"f8cf0627-5815-4aeb-b818-9ba9b281dd6e\",\n \"JobDeploymentEmploymentID\": \"EMP0023\",\n \"JobGUID\": \"5cd8a71e-4c27-4bcf-8f89-992f0d5872c2\",\n \"JobName\": \"Board Member\",\n \"JobCode\": \"BRDMEMBER\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2015-05-19T11:04:08.817Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"bf372d7f-c32a-37af-cd50-6defdd79318f"},{"name":"Add an Employee's Job Deployment","id":"18165f09-46ab-bfc8-2ec9-713a03b00638","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"PrimaryJobDeployment\": \"1\",\n \"JobName\": \"Administration\",\n \"JobCode\": \"ADM\"\n}"},"url":"{{url}}/JobDeployments?$format=json","description":"

This request will insert a Job Deployment record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["JobDeployments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"430668ec-ea6f-e2be-bb56-0540f0fb194c","name":"Add an Employee's Job Deployment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"PrimaryJobDeployment\": \"1\",\n\t\"JobName\": \"Administration\",\n\t\"JobCode\": \"ADM\"\n}"},"url":{"raw":"{{url}}/JobDeployments?$format=json","host":["{{url}}"],"path":["JobDeployments"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"525","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 03 Jan 2018 08:40:57 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/JobDeployments(EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',JobCode='ADM',PersonCode='26',PrimaryJobDeployment=1)","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"1422","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#JobDeployments/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"PrimaryJobDeployment\": 1,\n \"Comments\": null,\n \"DeploymentReason\": null,\n \"DeploymentReasonCode\": null,\n \"JobDeploymentEmploymentGUID\": null,\n \"JobDeploymentEmploymentID\": null,\n \"JobGUID\": null,\n \"JobName\": \"Administration\",\n \"JobCode\": \"ADM\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.8180905Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"18165f09-46ab-bfc8-2ec9-713a03b00638"},{"name":"Update an Employee's Job Deployment record","id":"95af6640-afcb-4a13-a557-61743cf4ad96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/JobDeployments(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', PrimaryJobDeployment=[PrimaryJobDeployment], JobCode='[JobCode]')","description":"

This request will update an employee's Job Deployment record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom, PrimaryJobDeployment and JobCode cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["JobDeployments(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', PrimaryJobDeployment=[PrimaryJobDeployment], JobCode='[JobCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"95af6640-afcb-4a13-a557-61743cf4ad96"},{"name":"Delete an Employee's Job Deployment record","id":"f315fe31-e080-f08b-6ffa-caac53dc5924","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/JobDeployments(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', PrimaryJobDeployment=[PrimaryJobDeployment], JobCode='[JobCode]')","description":"

This request will delete an employee's Job Deployment record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Person Job Deployments screen for active and inactive employees to be retrieved and modified.

The identifying keys for Job Deployments are:

PersonCode
EffectiveFrom
PrimaryJobDeployment
JobCode

\n\n

Fields

\n\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonCode	Y	Key.
FullName		Read-only.
EffectiveFrom	Y	Key.
EffectiveTo	Y
PrimaryJobDeployment	Y	Key. 1 = Ticked, 0 = Not Ticked.
Comments
DeploymentReason
DeploymentReasonCode
JobDeploymentEmploymentGUID		Read-only.
JobDeploymentEmploymentID
JobGUID		Read-only.
JobName	Y
JobCode	Y	Key. Read-only.
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"f48c936c-d73a-4ed5-b1d2-b602e1c58ced","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f7502559-479c-4b20-80b6-bb090e6d7abf","type":"text/javascript","exec":[""]}}],"_postman_id":"bd139199-5646-75dd-a3aa-390003b8ae17"},{"name":"Deployments (Org Unit / Positions)","item":[{"name":"List of Employee Deployments","id":"330d4211-de3d-b37d-57e1-5a2c88bea565","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/OrgUnitPositionDeployments?$format=json","description":"

This request will return a list of Employee Org Unit / Position Deployments from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["OrgUnitPositionDeployments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"fcb1d90c-90b7-5503-df23-8dd65a9daf40","name":"List of Employee Deployments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/OrgUnitPositionDeployments?$format=json","host":["{{url}}"],"path":["OrgUnitPositionDeployments"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"757","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 12:00:49 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"1123","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#OrgUnitPositionDeployments\",\n \"value\": [\n {\n \"PersonGUID\": \"35ac3768-0db0-4c1d-a9e4-3149d9ded7bf\",\n \"DeploymentGUID\": \"db162c7c-7526-40a1-a4a3-ebbb5043a6fe\",\n \"PersonCode\": \"0590\",\n \"FullName\": \"Lawrence Edwards\",\n \"EffectiveFrom\": \"1990-01-01T00:00:00\",\n \"EffectiveTo\": \"2008-03-29T00:00:00\",\n \"SortOrder\": 0,\n \"OrgUnitGUID\": \"6816adf2-92b1-4424-a3e1-884f053261a6\",\n \"OrgUnitCode\": \"cccc\",\n \"OrgUnitName\": \"Personnel - USA\",\n \"OrgUnitArea\": \"Human Resources\",\n \"OrgUnitType\": null,\n \"PersonGrade\": null,\n \"PositionGUID\": null,\n \"PositionCode\": null,\n \"PositionTitle\": null,\n \"DeploymentReason\": null,\n \"DeploymentReasonCode\": null,\n \"DeploymentEmploymentGUID\": null,\n \"DeploymentEmploymentID\": null,\n \"BusinessTitle\": null,\n \"PrimaryDeployment\": 1,\n \"ManagerOfUnit\": 1,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-08-03T11:07:29.013Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"NumberOfSubordinates\": 3,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n }\n ]\n}"}],"_postman_id":"330d4211-de3d-b37d-57e1-5a2c88bea565"},{"name":"Add an Employee's Org Unit Deployment","id":"259b938b-6a25-aa6f-409e-f412d8277569","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"clientSecret":"","clientId":"","challengeAlgorithm":"","scope":"","grant_type":"","client_authentication":"","accessTokenUrl":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"DeploymentGUID\": \"5535c41b-3eb8-4d00-9910-0022453a333f\",\n \"PersonCode\": \"CEZ0094\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"OrgUnitCode\": \"ADM\",\n \"PrimaryDeployment\": \"1\",\n \"ManagerOfUnit\": \"0\"\n}"},"url":"{{url}}/OrgUnitPositionDeployments?$format=json","description":"

This request will insert an Org Unit Deployment record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["OrgUnitPositionDeployments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"91b4e482-0604-1bdd-c21e-68b301b553e6","name":"Add an Employee's Org Unit Deployment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"DeploymentGUID\": \"5535c41b-3eb8-4d00-9910-0022453a333f\",\n\t\"PersonCode\": \"CEZ0094\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"OrgUnitCode\": \"ADM\",\n\t\"PrimaryDeployment\": \"1\",\n\t\"ManagerOfUnit\": \"0\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/OrgUnitPositionDeployments?$format=json","host":["{{url}}"],"path":["OrgUnitPositionDeployments"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"695","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 03 Jan 2018 08:48:21 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/OrgUnitPositionDeployments(EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',OrgUnitCode='ADM',PersonCode='CEZ0094',PrimaryDeployment=1)","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"1407","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#OrgUnitPositionDeployments/@Element\",\n \"PersonGUID\": null,\n \"DeploymentGUID\": \"5535c41b-3eb8-4d00-9910-0022453a333f\",\n \"PersonCode\": \"CEZ0094\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"SortOrder\": 0,\n \"OrgUnitGUID\": null,\n \"OrgUnitCode\": \"ADM\",\n \"OrgUnitName\": null,\n \"OrgUnitArea\": null,\n \"OrgUnitType\": null,\n \"PersonGrade\": null,\n \"PositionGUID\": null,\n \"PositionCode\": null,\n \"PositionTitle\": null,\n \"DeploymentReason\": null,\n \"DeploymentReasonCode\": null,\n \"DeploymentEmploymentGUID\": null,\n \"DeploymentEmploymentID\": null,\n \"BusinessTitle\": null,\n \"PrimaryDeployment\": 1,\n \"ManagerOfUnit\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.8180905Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"NumberOfSubordinates\": null,\n \"FreeCheckbox1\": null,\n \"FreeCheckbox2\": null,\n \"FreeDate1\": null,\n \"FreeDate2\": null,\n \"FreeNumber1\": null,\n \"FreeNumber2\": null,\n \"FreeNumericUpDown1\": null,\n \"FreeNumericUpDown2\": null,\n \"FreeRichText1\": null,\n \"FreeText1\": null,\n \"FreeText2\": null,\n \"FreeText3\": null,\n \"FreeText4\": null,\n \"FreeText5\": null,\n \"FreeTextMultiLine1\": null,\n \"FreeTextMultiLine2\": null\n}"}],"_postman_id":"259b938b-6a25-aa6f-409e-f412d8277569"},{"name":"Update an Employee's Org Unit Deployment","id":"fb404c88-35a6-46e9-a9ba-7cffea813775","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DeploymentReason\": \"Example Reason\"\n}"},"url":"{{url}}/OrgUnitPositionDeployments(DeploymentGUID=guid'[DeploymentGUID]')","description":"

This request will update an employee's Org Unit Deployment record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["OrgUnitPositionDeployments(DeploymentGUID=guid'[DeploymentGUID]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb404c88-35a6-46e9-a9ba-7cffea813775"},{"name":"Delete an Employee's Org Unit Deployment","id":"09e4cae9-2069-e9f2-4bbf-3b91a20027a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/OrgUnitPositionDeployments(DeploymentGUID='[DeploymentGUID]')","description":"

This request will delete an employee's Org Unit Deployment record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["OrgUnitPositionDeployments(DeploymentGUID='[DeploymentGUID]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"09e4cae9-2069-e9f2-4bbf-3b91a20027a3"}],"id":"d803480c-4785-29b9-f51c-762c0b356b8f","description":"

This API enables all information from the Org Units / Positions screen for active and inactive employees to be retrieved and modified.

The identifying key for Deployments is:

DeploymentGUID

\n\n\n

Note:

\nIn v1 and v2 of the API, the identifying keys are:\n

PersonCode
EffectiveFrom
OrgUnitCode
PrimaryDeployment

\n\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonGUID		Read-only.
DeploymentGUID	Y	Key.
PersonCode	Y	Read-only.
FullName		Read-only.
EffectiveFrom	Y	Read-only.
EffectiveTo	Y
SortOrder
OrgUnitGUID		Read-only.
OrgUnitCode	Y	Read-only.
OrgUnitName		Read-only.
OrgUnitArea		Read-only.
OrgUnitType		Read-only.
PersonGrade		Read-only.
PositionGUID		Read-only.
PositionCode
PositionTitle
DeploymentReason
DeploymentReasonCode
DeploymentEmploymentGUID		Read-only.
DeploymentEmploymentID
BusinessTitle
PrimaryDeployment	Y	Key. 1 = Ticked, 0 = Not Ticked.
ManagerOfUnit	Y	1 = Ticked, 0 = Not Ticked.
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
NumberOfSubordinates		Read-only.
FreeCheckbox1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeCheckbox3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeDate2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumber2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeNumericUpDown2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeRichText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText3		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText4		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeText5		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine1		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)
FreeTextMultiLine2		Available if enabled for the API User's Security Role from the Security tab for the free field within Object Management (Administration >> Object Management)

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has read-only access to everyone in the system.
Line Manager	Has read-only access to everyone in the system.
Self Service	Has read-only access to everyone in the system.

","event":[{"listen":"prerequest","script":{"id":"3dbb6e97-a62e-4eb4-be45-02dd0c97a1b9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"48e2a40d-3d29-4df1-9b01-cdd6af413aa6","type":"text/javascript","exec":[""]}}],"_postman_id":"d803480c-4785-29b9-f51c-762c0b356b8f"},{"name":"Cost Centre Deployments","item":[{"name":"List of Employee Cost Centre Deployments","id":"a4d56e81-f487-d0e8-9abf-89968b2f34da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/CostCentreDeployments?$format=json","description":"

This request will return a list of Cost Centre Deployments from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["CostCentreDeployments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"3acf0bc8-8606-d67a-9dee-7d3505e4aadd","name":"List of Employee Cost Centre Deployments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/CostCentreDeployments?$format=json","host":["{{url}}"],"path":["CostCentreDeployments"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"603","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 11:29:16 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"533","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#CostCentreDeployments\",\n \"value\": [\n {\n \"PersonCode\": \"CE59\",\n \"FullName\": \"Shawn Acker\",\n \"EffectiveFrom\": \"2007-01-01T00:00:00\",\n \"EffectiveTo\": \"2015-06-18T00:00:00\",\n \"CostCentreEmploymentId\": \"EMP0002\",\n \"PrimaryCostCentre\": 1,\n \"DeploymentReason\": \"New Hire\",\n \"DeploymentReasonCode\": \"DR1\",\n \"CostCentreName\": \"OM000 - Board\",\n \"CostCentreCode\": \"OM000\",\n \"Comments\": null,\n \"WorkingTimePercentage\": \"100.00\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2015-06-19T10:53:58.527Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"a4d56e81-f487-d0e8-9abf-89968b2f34da"},{"name":"Add an Employee's Cost Centre Deployment","id":"160723b1-8d84-97f4-1cd1-da9c4822ffa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"PrimaryCostCentre\": \"1\",\n \"CostCentreName\": \"Sales\",\n \"CostCentreCode\": \"TCC001\"\n}"},"url":"{{url}}/CostCentreDeployments?$format=json","description":"

This request will insert a Cost Centre Deployment record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["CostCentreDeployments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"7a70d096-46b8-3d27-537e-54f7b50ebad1","name":"Add an Employee's Cost Centre Deployment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"PrimaryCostCentre\": \"1\",\n\t\"CostCentreName\": \"Sales\",\n\t\"CostCentreCode\": \"TCC001\"\n}"},"url":{"raw":"{{url}}/CostCentreDeployments?$format=json","host":["{{url}}"],"path":["CostCentreDeployments"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"563","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 03 Jan 2018 08:50:34 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/CostCentreDeployments(CostCentreCode='TCC001',EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',PersonCode='26',PrimaryCostCentre=1)","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"850","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#CostCentreDeployments/@Element\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"CostCentreEmploymentId\": null,\n \"PrimaryCostCentre\": 1,\n \"DeploymentReason\": null,\n \"DeploymentReasonCode\": null,\n \"CostCentreName\": \"Sales\",\n \"CostCentreCode\": \"TCC001\",\n \"Comments\": null,\n \"WorkingTimePercentage\": \"100\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:02.833699Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"160723b1-8d84-97f4-1cd1-da9c4822ffa8"},{"name":"Update an Employee's Cost Centre Deployment","id":"09d2e22f-d035-4ca9-a5a3-ded0313a6ed2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/CostCentreDeployments(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', PrimaryCostCentre='[PrimaryCostCentre]', CostCentreCode='[CostCentreCode]')","description":"

This request will update an employee's Cost Centre Deployment record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom, PrimaryCostCentre and CostCentreCode cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["CostCentreDeployments(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', PrimaryCostCentre='[PrimaryCostCentre]', CostCentreCode='[CostCentreCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"09d2e22f-d035-4ca9-a5a3-ded0313a6ed2"},{"name":"Delete an Employee's Cost Centre Deployment","id":"72714f27-3d2c-6754-b715-2517508b756b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/CostCentreDeployments(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', PrimaryCostCentre='[PrimaryCostCentre]', CostCentreCode='[CostCentreCode]')","description":"

This request will delete an employee's Cost Centre Deployment record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Person Cost Centre Deployments screen for active and inactive employees to be retrieved and modified.

The identifying keys for Cost Centre Deployments are:

PersonCode
EffectiveFrom
PrimaryCostCentre
CostCentreCode

\n\n

Fields

\n\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonCode	Y	Key.
FullName		Read-only.
EffectiveFrom	Y	Key.
EffectiveTo	Y
CostCentreEmploymentId
PrimaryCostCentre	Y	Key. 1 = Ticked, 0 = Not Ticked.
DeploymentReason
DeploymentReasonCode
CostCentreName	Y
CostCentreCode	Y	Key. Read-only.
Comments
WorkingTimePercentage
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"af9a9b7a-90ec-4668-a610-8d9e05282675","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9e12d404-c415-43fb-b1d8-1f9b5953d4be","type":"text/javascript","exec":[""]}}],"_postman_id":"fd37f31f-0556-9474-9736-953a5ce21821"},{"name":"Reports To (Read-Only)","item":[{"name":"List of Employee Reports To / Supervisor Records","id":"b2c9c9d5-6763-45b7-9bd1-500ca8ad5356","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/PersonReportsTo?$format=json","description":"

This request will return a list of Reports To / Supervisor Records from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["PersonReportsTo"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"d8ede915-a572-414f-b786-ee010371d858","name":"List of Employee Reports To / Supervisor Records","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/PersonReportsTo?$format=json","host":["{{url}}"],"path":["PersonReportsTo"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Fri, 07 Jun 2019 17:12:41 GMT"},{"key":"Content-Length","value":"1796"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PersonReportsTo\",\n \"value\": [\n {\n \"PersonGUID\": \"5d6yg0e1-546b-61f7-a445-023e0b84ad6d\",\n \"ReportsToGUID\": \"556745d3-26b8-4hgr-a16d-86f5t785r775\",\n \"FamilyName\": \"Harper\",\n \"FirstName\": \"Claire\",\n \"FullName\": \"Claire Harper\",\n \"KnownAs\": \"Claire\",\n \"PersonCode\": \"6098\",\n \"InternalEmail\": \"ClaireHarper@omnicrom.com\",\n \"WorkNumber\": \"0117 366 5001\",\n \"WorkExtension\": null,\n \"MobileNumber\": null,\n \"EmploymentID\": \"6098\",\n \"ActiveEmployee\": 1,\n \"CompanyCode\": \"OMMAN\",\n \"CompanyName\": \"Omnicrom Manufacturing Ltd\",\n \"DeploymentEmploymentID\": null,\n \"DeploymentActiveEmployee\": 0,\n \"DeploymentCompanyCode\": null,\n \"DeploymentCompanyName\": null,\n \"ManagerOfUnit\": 0,\n \"ReportingOverride\": 0,\n \"LastModifiedDate\": \"2011-02-15T14:00:58.973Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"OrgUnitCode\": \"MEGOP\",\n \"OrgUnitName\": \"Operations\",\n \"PositionCode\": \"PRO5105\",\n \"PositionTitle\": \"Programmer\",\n \"SupervisorPersonGUID\": \"385c1995-87d1-3957-bd97-294rta09e905\",\n \"SupervisorFamilyName\": \"Sing\",\n \"SupervisorFirstName\": \"Sharma\",\n \"SupervisorFullName\": \"Sharma Sing\",\n \"SupervisorKnownAs\": \"Sharma\",\n \"SupervisorPersonID\": \"8921\",\n \"SupervisorInternalEmailAddress\": \"SharmaSing@omnicrom.com\",\n \"SupervisorWorkNumber\": \"01225 456 221\",\n \"SupervisorWorkExtension\": null,\n \"SupervisorMobileNumber\": null,\n \"SupervisorEmploymentID\": \"8921\",\n \"SupervisorActiveEmployee\": 1,\n \"SupervisorCompanyCode\": \"OMMAN\",\n \"SupervisorCompanyName\": \"Omnicrom Manufacturing Ltd\",\n \"SupervisorDeploymentEmploymentID\": null,\n \"SupervisorDeploymentActiveEmployee\": 0,\n \"SupervisorDeploymentCompanyCode\": null,\n \"SupervisorDeploymentCompanyName\": null,\n \"SupervisorManagerOfUnit\": 1,\n \"SupervisorOrgUnitCode\": \"MEGOP\",\n \"SupervisorOrgUnitName\": \"Operations\",\n \"SupervisorPositionCode\": \"CP2680\",\n \"SupervisorPositionTitle\": \"Operations Director\",\n \"PrimaryDeployment\": \"1\"\n }\n ]\n}"}],"_postman_id":"b2c9c9d5-6763-45b7-9bd1-500ca8ad5356"}],"id":"4189ed02-8210-46f5-a94a-a14f2568b672","description":"

This API enables all information from the Reports To tab on the Org Units / Positions screen and supervisor information for active and inactive employees to be retrieved.

The identifying keys for Person Reports To are:

PersonGUID
ReportsToGUID

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonGUID		Key. Read-only.
ReportsToGUID		Key. Read-only.
FamilyName		Read-only.
FirstName		Read-only.
FullName		Read-only.
KnownAs		Read-only.
PersonCode		Read-only.
InternalEmail		Read-only.
WorkNumber		Read-only.
WorkExtension		Read-only.
MobileNumber		Read-only.
EmploymentID		Read-only.
ActiveEmployee		Read-only.
CompanyCode		Read-only.
CompanyName		Read-only.
DeploymentEmploymentID		Read-only.
DeploymentActiveEmployee		Read-only.
DeploymentCompanyCode		Read-only.
DeploymentCompanyName		Read-only.
ManagerOfUnit		Read-only.
ReportingOverride		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
InsertUser		Read-only.
OrgUnitCode		Read-only.
OrgUnitName		Read-only.
PositionCode		Read-only.
PositionTitle		Read-only.
SupervisorPersonGUID		Read-only.
SupervisorFamilyName		Read-only.
SupervisorFirstName		Read-only.
SupervisorFullName		Read-only.
SupervisorKnownAs		Read-only.
SupervisorPersonID		Read-only.
SupervisorInternalEmailAddress		Read-only.
SupervisorWorkNumber		Read-only.
SupervisorWorkExtension		Read-only.
SupervisorMobileNumber		Read-only.
SupervisorEmploymentID		Read-only.
SupervisorActiveEmployee		Read-only.
SupervisorCompanyCode		Read-only.
SupervisorCompanyName		Read-only.
SupervisorDeploymentEmploymentID		Read-only.
SupervisorDeploymentActiveEmployee		Read-only.
SupervisorDeploymentCompanyCode		Read-only.
SupervisorDeploymentCompanyName		Read-only.
SupervisorManagerOfUnit		Read-only.
SupervisorOrgUnitCode		Read-only.
SupervisorOrgUnitName		Read-only.
SupervisorPositionCode		Read-only.
SupervisorPositionTitle		Read-only.
PrimaryDeployment		Read-only. 1 = Primary, 0 = Non-Primary.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to everyone within the system.
Restricted HR Professional	Has no access to this API.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"eafd57b3-350a-4ca2-aa93-28b263b83a49","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9cd8a69f-1c81-4016-8a3c-4f0828fa88ff","type":"text/javascript","exec":[""]}}],"_postman_id":"4189ed02-8210-46f5-a94a-a14f2568b672"},{"name":"Approvers by Type (Read-Only)","item":[{"name":"List of Employee Approvers by Type Records","id":"8545c9d4-66ea-4e25-869d-2eefaae4284b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/ApproversByType?$format=json","description":"

This request will return a list of Reports To / Supervisor Records from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["ApproversByType"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"15ed0683-32fb-4a2e-bff5-7eae49fc1049","name":"List of Employee Approvers by Type Records","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/PersonReportsTo?$format=json","host":["{{url}}"],"path":["PersonReportsTo"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Fri, 07 Jun 2019 17:12:41 GMT"},{"key":"Content-Length","value":"1796"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#ApproversByType\",\n \"value\": [\n {\n \"PersonGUID\": \"5d6yg0e1-546b-61f7-a445-023e0b84ad6d\",\n \"PersonCode\": \"6098\",\n \"PersonName\": \"Claire Harper\",\n \"AdditionalApproversGUID\": \"556745d3-26b8-4hgr-a16d-86f5t785r775\",\n \"EffectiveFrom\": \"2020-02-15T00:00:00Z\",\n \"EffectiveTo\": \"2020-10-15T00:00:00Z\",\n \"ApproverTypeDescription\": \"Claire Harper\",\n \"ApproverUserGUID\": \"385c1995-87d1-3957-bd97-294rta09e905\",\n \"ApproverUserName\": \"SharmaSing@omnicrom.com\",\n \"CategoryName\": \"All Categories\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2020-02-15T14:00:58.973Z\",\n \"WorkflowProcessName\": null,\n \"WorkflowIsTerminated\": \"0\"\n }\n ]\n}"}],"_postman_id":"8545c9d4-66ea-4e25-869d-2eefaae4284b"}],"id":"2aef051f-2ddd-47a1-a740-bfd9307da5a0","description":"

This API enables all information from the Approvers by Type screen for active and inactive employees to be retrieved.

The identifying keys for Approvers by Type are:

PersonGUID
ReportsToGUID

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonGUID		Key. Read-only.
PersonCode		Read-only.
PersonName		Read-only.
AdditionalApproversGUID		Key. Read-only.
EffectiveFrom		Read-only.
EffectiveTo		Read-only.
ApproverTypeDescription		Read-only.
ApproverUserGUID		Read-only.
ApproverUserName		Read-only.
CategoryName		Read-only.
Comments		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
WorkflowProcessName		Read-only.
WorkflowIsTerminated		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to everyone within the system.
Restricted HR Professional	Has no access to this API.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"40be0d4d-be1a-43d3-82b8-3f4b07fe1484","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0487b49e-4d72-4775-9362-060279679cdb","type":"text/javascript","exec":[""]}}],"_postman_id":"2aef051f-2ddd-47a1-a740-bfd9307da5a0"}],"id":"12689d37-6799-0169-370f-ae9deb83197c","_postman_id":"12689d37-6799-0169-370f-ae9deb83197c","description":""},{"name":"Inventory Items","item":[{"name":"Inventory Items","item":[{"name":"List all Inventory Items","id":"4e4b09f8-7569-4914-9c05-b0629798deda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/InventoryItems?$format=json","description":"

This request will return a list of Inventory Items from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["InventoryItems"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"disabled":true,"key":"$top","value":"1"}],"variable":[]}},"response":[{"id":"328a00a8-917d-4729-8fe5-885cd65194c2","name":"List all Inventory Items","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token","disabled":false}],"url":{"raw":"{{url}}/InventoryItems?$format=json","host":["{{url}}"],"path":["InventoryItems"],"query":[{"key":"$format","value":"json"},{"key":"$top","value":"1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"613","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":"Custom header"},{"key":"Date","value":"Fri, 01 Jun 2018 16:00:54 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#InventoryItems\",\n \"value\": [\n {\n \"InventoryItemGUID\": \"a58c9cfd-249f-49f0-93a5-93a73533ffb6\",\n \"Name\": \"Lenovo Laptop 3248\",\n \"Description\": null,\n \"InventoryType\": \"Laptop computer\",\n \"Model\": \"T61\",\n \"Version\": null,\n \"SerialNumber\": \"34859347-84259-8245092\",\n \"AssetNumber\": \"3248\",\n \"PurchaseDate\": \"2010-02-26T00:00:00\",\n \"RetiredDate\": null,\n \"DepreciationTime\": \"4\",\n \"OrgUnit\": \"Finance\",\n \"ItemStatus\": \"Active\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2010-10-04T11:51:34.827Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"4e4b09f8-7569-4914-9c05-b0629798deda"},{"name":"Add a new Inventory Item","id":"9fe251a3-f6c0-4c8a-8d08-2f58a1c58eb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Name\": \"Lenovo Laptop 3257\",\n\t\"InventoryType\": \"Laptop computer\",\n\t\"AssetNumber\": \"3258\"\n}"},"url":"{{url}}/InventoryItems?$format=json","description":"

This request will insert an Inventory Item record to the system.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["InventoryItems"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"9fe251a3-f6c0-4c8a-8d08-2f58a1c58eb4"},{"name":"Update an Inventory Item","id":"2b8324e5-2423-44ef-afd2-9c0c1cfb4274","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Name\": \"Lenovo Laptop 3257\"\n}"},"url":"{{url}}/InventoryItems(InventoryItemGUID=guid'[InventoryItemGUID]')","description":"

This request will update an Inventory Item in the system.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The InventoryItemGUID cannot be updated as it is the the key field for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["InventoryItems(InventoryItemGUID=guid'[InventoryItemGUID]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b8324e5-2423-44ef-afd2-9c0c1cfb4274"},{"name":"Delete an Inventory Item","id":"42e35a79-692c-4b92-bb7b-db20fe077204","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/InventoryItems(InventoryItemGUID=guid'[InventoryItemGUID]')","description":"

This request will delete an Inventory Item from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Inventory Items screen for active and inactive employees to be retrieved and modified.

The identifying key for Inventory Items is:

InventoryItemGUID

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
InventoryItemGUID	Y	Key. Read-only.
Name	Y	Key. Read-only.
Description
InventoryType	Y	Key. Read-only.
Model
Version
SerialNumber
AssetNumber	Y
PurchaseDate
RetiredDate
DepreciationTime
OrgUnit
ItemStatus
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to all records.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"81f6111b-1cc9-401f-bb4b-40ba4e077e7e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3f404111-5100-4c29-9f97-d7bf4452e812","type":"text/javascript","exec":[""]}}],"_postman_id":"79473e38-6a1f-4dbf-b761-8b4c5aec5c2f"},{"name":"Inventory Assignment","item":[{"name":"List of Employee Inventory Assignments","id":"27de597c-4b9a-43c2-b728-cbf09376e74f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/InventoryAssignment?$format=json","description":"

This request will return a list of Inventory Assignments from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["InventoryAssignment"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"27de597c-4b9a-43c2-b728-cbf09376e74f"},{"name":"Add an Employee's Inventory Assignment","id":"fcdb90c1-4f16-4465-8e3c-ba00679f46b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"EffectiveFrom\": \"2010-01-01T00:00:00\",\n\t\"InventoryItemGUID\": \"a58c9cfd-249f-49f0-93a5-93a73533ffb6\",\n\t\"PersonCode\": \"CEZ01\"\n}"},"url":"{{url}}/InventoryItems?$format=json","description":"

This request will insert an Inventory Assignment record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["InventoryItems"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"fcdb90c1-4f16-4465-8e3c-ba00679f46b3"},{"name":"Update an Employee's Inventory Assignment","id":"307d9652-b4a7-4b4a-adbe-920a62fdc629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Reason\": \"Example Reason\"\n}"},"url":"{{url}}/InventoryAssignment(EffectiveFrom=datetime'[EffectiveFrom]', InventoryItemGUID=guid'[InventoryItemGUID]', PersonCode='[PersonCode]')","description":"

This request will update an employee's Inventory Assignment record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The EffectiveFrom, InventoryItemGUID, and PersonCode cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["InventoryAssignment(EffectiveFrom=datetime'[EffectiveFrom]', InventoryItemGUID=guid'[InventoryItemGUID]', PersonCode='[PersonCode]')"],"host":["{{url}}"],"query":[{"disabled":true,"key":"$top","value":"1"}],"variable":[]}},"response":[],"_postman_id":"307d9652-b4a7-4b4a-adbe-920a62fdc629"},{"name":"Delete an Employee's Inventory Assignment","id":"ed3c26a8-8360-4b77-92ee-c0d3b411166c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"url":"{{url}}/InventoryAssignment(EffectiveFrom=datetime'[EffectiveFrom]', InventoryItemGUID=guid'[InventoryItemGUID]', PersonCode='[PersonCode]')","description":"

This request will delete an employee's Inventory Assignment record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Employee Inventory Assignments screen for active and inactive employees to be retrieved and modified.

The identifying keys for Inventory Assignments are:

EffectiveFrom
InventoryItemGUID
PersonCode

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
InventoryItemGUID	Y	Key. Read-only.
Model
Version	Y	Key. Read-only.
EffectiveFrom
EffectiveTo	Y
Reason	Y
AssigneeName		Read-only.
InventoryItem		Read-only.
InventoryItemType		Read-only.
AssetNumber		Read-only.
SerialNumber		Read-only.
Comments		Read-only.
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"1dfc39f0-5eca-4283-9f72-a1ec6a0616ca","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8e27a730-aa6b-4769-82e8-29c5e803020b","type":"text/javascript","exec":[""]}}],"_postman_id":"3778a723-8d40-4aa4-bc34-efe4d008e4f1"}],"id":"d32dcc13-e592-4258-83bb-a69d84de5a39","_postman_id":"d32dcc13-e592-4258-83bb-a69d84de5a39","description":""}],"id":"1860f4df-45e5-952b-0e73-dbc444ead93f","_postman_id":"1860f4df-45e5-952b-0e73-dbc444ead93f","description":""},{"name":"Absences","item":[{"name":"Adjustments (Read-Only)","item":[{"name":"List of Employee Absence Plan Adjustments","id":"bf8cd065-c5e8-aaf2-e996-7b398e3886db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/PersonAbsencePlanAdjustments?$format=json","description":"

This request will return a list of Absence Plan Adjustments from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["PersonAbsencePlanAdjustments"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"c1c2e232-2956-dbb3-4410-2c2788733004","name":"List of Employee Absence Plan Adjustments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/PersonAbsencePlanAdjustments?$format=json","host":["{{url}}"],"path":["PersonAbsencePlanAdjustments"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"581","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Thu, 27 Jul 2017 15:39:56 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"708","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PersonAbsencePlanAdjustments\",\n \"value\": [\n {\n \"AdjustmentEffectiveDate\": \"2017-01-01T00:00:00\",\n \"AdjustmentAmount\": \"1.00\",\n \"Notes\": null,\n \"TimeUnit\": \"Days\",\n \"AbsencePlanName\": \"Holiday\",\n \"ApprovedBy\": null,\n \"AdjustmentReason\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2016-11-29T12:18:31.453Z\",\n \"PersonCode\": \"40\",\n \"AbsencePlanEffectiveFrom\": \"2007-01-01T00:00:00\",\n \"AbsencePlanEffectiveTo\": \"2018-06-24T00:00:00\"\n }\n ]\n}"}],"_postman_id":"bf8cd065-c5e8-aaf2-e996-7b398e3886db"}],"id":"fed218c7-e153-3665-cd15-a17d8118fa9c","description":"

This API enables information from the Person Absence Plan Adjustments screen for active and inactive employees to be retrieved.

The identifying keys for Absence Adjustments are:

AdjustmentEffectiveDate
AbsencePlanName
PersonCode
AbsencePlanEffectiveFrom
AbsencePlanEffectiveTo

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
AdjustmentEffectiveDate	Y	Key. Read-only.
AdjustmentAmount		Read-only.
Notes		Read-only.
TimeUnit		Read-only.
AbsencePlanName	Y	Key. Read-only.
ApprovedBy		Read-only.
AdjustmentReason		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
PersonCode	Y	Key. Read-only.
AbsencePlanEffectiveFrom	Y	Key. Read-only.
AbsencePlanEffectiveTo	Y	Key. Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to everyone within the system.
Restricted HR Professional	Has no access to this API.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"e164ad62-4ea7-4954-aa0d-18290ce1c3dc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"22f2fd21-424c-4465-9cf5-0d21bbb7533b","type":"text/javascript","exec":[""]}}],"_postman_id":"fed218c7-e153-3665-cd15-a17d8118fa9c"},{"name":"Absence Event Details (Read-Only)","item":[{"name":"List of Person Absence Event Details","id":"a3de2714-8047-88e9-6ca7-230288789325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":"","tokenName":"","clientSecret":"{{clientsecret}}","clientId":"{{clientId}}","client_authentication":"","challengeAlgorithm":"","scope":"","grant_type":"","accessTokenUrl":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/PersonAbsenceEventDetails?$format=json","description":"

This request will return a list of Absence Event Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["PersonAbsenceEventDetails"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"disabled":true,"key":"$filter","value":"ReferenceDate ge datetime'2023-04-06'"}],"variable":[]}},"response":[{"id":"f51c6c51-4549-e9ba-ae23-a7ba65495ef6","name":"List of Absence Event Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/PersonAbsenceEventDetails?$format=json","host":["{{url}}"],"path":["PersonAbsenceEventDetails"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1602","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Wed, 26 Jul 2017 16:06:53 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"3150","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PersonAbsenceEventDetails\",\n \"value\": [\n {\n \"ReferenceDate\": \"2010-08-03T00:00:00\",\n \"AMStartTime\": null,\n \"AMEndTime\": null,\n \"AMWorkingHours\": \"0.00\",\n \"PMEndTime\": \"1900-01-01T17:30:00\",\n \"PMStartTime\": \"1900-01-01T13:45:00\",\n \"PMWorkingHours\": \"3.75\",\n \"DayTotalWorkingHours\": \"3.75\",\n \"WeekDay\": \"Tuesday\",\n \"AbsenceEventDetailInsertUser\": \"* cheryl.abrahams@omnicrom.com\",\n \"AbsenceEventDetailLastModifiedDate\": \"2016-10-13T14:17:58.873\",\n \"AbsenceEventDetailLastModifiedUser\": \"* cheryl.abrahams@omnicrom.com\",\n \"AbsenceEventSubmittedOn\": \"2011-08-02T16:07:52.23\",\n \"AbsenceEventRepliedOn\": \"2011-08-02T16:07:52.23\",\n \"AbsenceEventComments\": null,\n \"AbsenceEventEffectiveFrom\": \"2010-08-01T00:00:00\",\n \"AbsenceEventEffectiveTo\": \"2010-08-18T00:00:00\",\n \"Approver\": \"Philip Hobbs\",\n \"ApproverPersonCode\": \"9816\",\n \"AbsenceStatus\": \"Approved\",\n \"AbsenceReason\": \"Holiday\",\n \"AbsenceEventInsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"AbsenceEventLastModifiedDate\": \"2016-10-13T14:17:58.873\",\n \"AbsenceEventInsertDate\": \"2013-01-30T10:12:35.78\",\n \"AbsenceEventLastModifiedUser\": \"* philip.hobbs@omnicrom.com\",\n \"AbsencePlanTypeName\": \"Holiday\",\n \"AbsenceTypeName\": \"Holiday\",\n \"AbsenceCategory\": \"Holiday\",\n \"FirstName\": \"Cheryl\",\n \"FamilyName\": \"Abrahams\",\n \"FullName\": \"Cheryl Abrahams\",\n \"PersonCode\": \"26\",\n \"EmploymentId\": \"7637\",\n \"CompanyCode\": \"OMMAN\",\n \"CompanyName\": \"Omnicrom Manufacturing Ltd\",\n \"OrgUnitCode\": \"Marketing\",\n \"OrgUnitName\": \"Marketing - USA\",\n \"ActiveEmployee\": 1,\n \"AbsenceEventDetailCode\": \"5a728e94-83c0-414f-b952-000028f8081b\",\n \"AbsenceEventCode\": \"9e56e35a-3599-4dec-a43c-b037f19d7314\",\n \"SickPay\": 0\n }\n ]\n}"}],"_postman_id":"a3de2714-8047-88e9-6ca7-230288789325"}],"id":"84ae9166-089e-fbc7-bd45-14860bf4d22d","description":"

This API enables information from the Absence Event screen for active and inactive employees to be retrieved.

The identifying key for Absence Event Details is:

AbsenceEventDetailCode

\n\n

Fields

\n\n

Field	Mandatory	Comments
ReferenceDate		Read-only.
AMStartTime		Read-only.
AMEndTime		Read-only.
AMWorkingHours		Read-only.
PMEndTime		Read-only.
PMStartTime		Read-only.
PMWorkingHours		Read-only.
DayTotalWorkingHours		Read-only.
WeekDay		Read-only.
AbsenceEventDetailInsertUser		Read-only.
AbsenceEventDetailLastModifiedDate		Read-only.
AbsenceEventDetailLastModifiedUser		Read-only.
AbsenceEventSubmittedOn		Read-only.
AbsenceEventRepliedOn		Read-only.
AbsenceEventComments		Read-only.
AbsenceEventEffectiveFrom		Read-only.
AbsenceEventEffectiveTo		Read-only.
Approver		Read-only.
ApproverPersonCode		Read-only.
AbsenceStatus		Read-only.
AbsenceReason		Read-only.
AbsenceEventInsertUser		Read-only.
AbsenceEventLastModifiedDate		Read-only.
AbsenceEventInsertDate		Read-only.
AbsenceEventLastModifiedUser		Read-only.
AbsencePlanTypeName		Read-only.
AbsenceTypeName		Read-only.
AbsenceCategory		Read-only.
FirstName		Read-only.
FamilyName		Read-only.
FullName		Read-only.
PersonCode		Read-only.
EmploymentId		Read-only.
CompanyCode		Read-only.
CompanyName		Read-only.
OrgUnitCode		Read-only.
OrgUnitName		Read-only.
ActiveEmployee		Read-only. 1 = Ticked, 0 = Not Ticked.
AbsenceEventDetailCode	Y	Key. Read-only.
AbsenceEventCode		Read-only.
SickPay		Read-only. 1 = Ticked, 0 = Not Ticked.
ExcludeFromBradfordFactor		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to everyone within the system.
Restricted HR Professional	Has no access to this API.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"0909e903-848c-41ec-b68d-a154fae1a614","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f986768a-f75a-4dd3-8ca8-ab4211be4dfc","type":"text/javascript","exec":[""]}}],"_postman_id":"84ae9166-089e-fbc7-bd45-14860bf4d22d"},{"name":"Absence Events (Read-Only)","item":[{"name":"List of Person Absence Events","id":"cf1ad7be-d853-7da5-62d8-18f9194ee292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/PersonAbsenceEvents?$format=json","description":"

This request will return a list of Absence Events from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["PersonAbsenceEvents"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"857e6af8-5986-cdf3-5b28-3e29cab05966","name":"List of Absence Events","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/PersonAbsenceEvents?$format=json","host":["{{url}}"],"path":["PersonAbsenceEvents"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1346","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Wed, 26 Jul 2017 16:08:48 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"2051","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PersonAbsenceEvents\",\n \"value\": [\n {\n \"PersonGUID\": \"1c586055-c095-4582-bb15-c76aec89b75d\",\n \"PersonAbsenceEventGUID\": \"23d7b9f1-b9e3-484a-89e3-0000725c9846\",\n \"AbsenceEventSubmittedOn\": \"2015-12-11T00:00:00\",\n \"AbsenceEventRepliedOn\": \"2015-12-11T00:00:00\",\n \"AbsenceNotes\": null,\n \"AbsenceEventEffectiveFrom\": \"2015-12-29T00:00:00\",\n \"AbsenceEventEffectiveTo\": \"2015-12-29T00:00:00\",\n \"Approver\": null,\n \"ApproverPersonCode\": null,\n \"AbsenceStatus\": \"Approved\",\n \"AbsenceReason\": \"Holiday\",\n \"AbsenceEventInsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"AbsenceEventLastModifiedDate\": \"2016-10-13T14:20:40.62\",\n \"AbsenceEventInsertDate\": \"2015-12-11T16:07:06.28\",\n \"AbsenceEventLastModifiedUser\": \"* cheryl.abrahams@omnicrom.com\",\n \"AbsencePlanTypeName\": \"Holiday\",\n \"AbsenceTypeName\": \"Holiday\",\n \"AbsenceCategory\": \"Holiday\",\n \"FirstName\": \"Peter\",\n \"FamilyName\": \"Masters\",\n \"FullName\": \"Peter Masters\",\n \"PersonCode\": \"5648\",\n \"EmploymentID\": \"5648\",\n \"CompanyCode\": \"OMMAN\",\n \"CompanyName\": \"Omnicrom Manufacturing Ltd\",\n \"OrgUnitCode\": \"HR\",\n \"OrgUnitName\": \"HR\",\n \"ActiveEmployee\": 1,\n \"CommencesCode\": \"M\",\n \"Commences\": \"Middle of Day\",\n \"FinishesCode\": \"E\",\n \"Finishes\": \"End of Day\",\n \"TimeUnits\": \"Days\",\n \"TotalByTimeUnit\": \"0.50\",\n \"TotalDays\": \"0.50\",\n \"TotalWorkingTimeTakenByTimeUnit\": \"0.50\",\n \"AbsenceEventTotalWorkingHours\": \"3.75\",\n \"OpenEndedSickness\": 0,\n \"ApproverPersonGUID\": \"9d5c2433-9211-477b-b3cc-a76adc6d89ca\",\n \"EmploymentGUID\": \"d9ebc669-2667-4f17-ad7b-a745f4479690\",\n \"CompanyGUID\": \"9e91e0db-0e96-4917-8f64-3021c3213012\",\n \"OrgUnitGUID\": \"9ae84ac4-8ed5-4382-85c5-d256c7d25617\"\n }\n ]\n}"}],"_postman_id":"cf1ad7be-d853-7da5-62d8-18f9194ee292"}],"id":"b7650931-d92f-a492-cfa1-4bd6cb486569","description":"

This API enables information from the Absence Event screen for active and inactive employees to be retrieved.

The identifying key for Absence Events is:

PersonAbsenceEventGUID

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonGUID		Read-only.
PersonAbsenceEventGUID		Key. Read-only.
AbsenceEventSubmittedOn		Read-only.
AbsenceEventRepliedOn		Read-only.
AbsenceNotes		Read-only.
AbsenceEventEffectiveFrom		Read-only.
AbsenceEventEffectiveTo		Read-only.
Approver		Read-only.
ApproverPersonCode		Read-only.
AbsenceStatus		Read-only.
AbsenceReason		Read-only.
AbsenceEventInsertUser		Read-only.
AbsenceEventLastModifiedDate		Read-only.
AbsenceEventInsertDate		Read-only.
AbsenceEventLastModifiedUser		Read-only.
AbsencePlanTypeName		Read-only.
AbsenceTypeName		Read-only.
AbsenceCategory		Read-only.
FirstName		Read-only.
FamilyName		Read-only.
FullName		Read-only.
PersonCode		Read-only.
EmploymentID		Read-only.
CompanyCode		Read-only.
CompanyName		Read-only.
OrgUnitCode		Read-only.
OrgUnitName		Read-only.
ActiveEmployee		Read-only. 1 = Ticked, 0 = Not Ticked.
CommencesCode		Read-only.
Commences		Read-only.
FinishesCode		Read-only.
Finishes		Read-only.
TimeUnits		Read-only.
TotalByTimeUnit		Read-only.
TotalDays		Read-only.
TotalWorkingTimeTakenByTimeUnit		Read-only.
AbsenceEventTotalWorkingHours		Read-only.
OpenEndedSickness		Read-only. 1 = Ticked, 0 = Not Ticked.
ApproverPersonGUID		Read-only.
EmploymentGUID		Read-only.
CompanyGUID		Read-only.
OrgUnitGUID		Read-only.
ExcludeFromBradfordFactor		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"238c51c5-496d-4a64-8091-c68858ce2f9f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2261efd6-9f37-441e-afbd-000cb0e8de87","type":"text/javascript","exec":[""]}}],"_postman_id":"b7650931-d92f-a492-cfa1-4bd6cb486569"},{"name":"Deleted Absence Events (Read-Only)","item":[{"name":"List of Deleted Absence Events","id":"8b9987bc-db95-4b4c-9b46-d90e48e7727f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{url}}/PersonAbsenceDeletedEvents?$format=json","description":"

This request will return a list of physically Deleted Absence Event Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["PersonAbsenceDeletedEvents"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"33cfb2b3-30e1-499f-8016-e3b9a304cdca","name":"List of Deleted Absence Events","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/PersonAbsenceDeletedEvents?$format=json","host":["{{url}}"],"path":["PersonAbsenceDeletedEvents"],"query":[{"key":"$format","value":"json"},{"key":"$top","value":"1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Fri, 08 Feb 2019 10:37:16 GMT"},{"key":"Content-Length","value":"385"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PersonAbsenceDeletedEvents\",\n \"value\": [\n {\n \"PersonCode\": \"CEZ01\",\n \"PersonAbsenceEventsDeleteAuditCode\": \"543789ba-d3fc-2222-45c7-244b0f6790d5\",\n \"ActionDate\": \"2017-12-07T00:00:00\",\n \"AbsenceEventGuid\": \"4325670a-8795-4446-bfc3-dc03bf56bc11\",\n \"EffectiveFrom\": \"2015-09-07T00:00:00\",\n \"EffectiveTo\": \"2015-09-28T00:00:00\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"8b9987bc-db95-4b4c-9b46-d90e48e7727f"}],"id":"f2f92115-44c6-4059-a0b6-49a2d830192b","description":"

This API enables information about physically deleted absence events for active and inactive employees to be retrieved.

The identifying key for Deleted Absence Events is:

PersonAbsenceEventsDeleteAuditCode

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
PersonCode		Read-only.
PersonAbsenceEventsDeleteAuditCode		Read-only.
ActionDate		Read-only.
AbsenceEventGuid		Read-only.
EffectiveFrom		Read-only.
EffectiveTo		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has no access to this API.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"9796aa27-2f01-4a1e-b62b-0823eccaa627","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f971c20a-cfb8-4c47-b947-891d01f6c611","type":"text/javascript","exec":[""]}}],"_postman_id":"f2f92115-44c6-4059-a0b6-49a2d830192b"},{"name":"Time Off In Lieu (TOIL) (Read-Only)","item":[{"name":"List of Time Off In Lieu (TOIL) records","id":"2d8cae3c-6367-43c1-a8ba-d9c9563b52d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{url}}/TimeOffInLieu?$format=json","description":"

This request will return a list of Time Off In Lieu (TOIL) Event Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["TimeOffInLieu"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"7efd111c-6ee6-45aa-996b-67b752d94d58","name":"List of all Time Off In Lieu (TOIL) records","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer Your-API-Token","type":"text"}],"url":{"raw":"{{url}}/TimeOffInLieu?$format=json","host":["{{url}}"],"path":["TimeOffInLieu"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Thu, 28 Mar 2019 14:32:39 GMT"},{"key":"Content-Length","value":"695"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#TimeOffInLieu\",\n \"value\": [\n {\n \"PersonCode\": \"CEZ03\",\n \"UsedTOIL\": \"0.00\",\n \"RemainingTOIL\": \"0.00\",\n \"EmployeeName\": \"Brenda Becker\",\n \"PersonAbsenceToilGuid\": \"6f5555e6-3cf3-2e1c-34df-bvr33a3c467e\",\n \"AbsenceType\": \"Holiday\",\n \"WorkedFrom\": \"2019-03-30T00:00:00\",\n \"WorkedTo\": \"2019-03-30T00:00:00\",\n \"Reason\": \"Weekday Overtime\",\n \"TakenAsPay\": 1,\n \"TOILEffectiveFrom\": \"2019-03-31T00:00:00\",\n \"TOILExpiry\": \"2999-12-31T00:00:00\",\n \"Notes\": null,\n \"TOILEarned\": \"0.00\",\n \"TOILTimeUnits\": \"Days\",\n \"Status\": \"Approved\",\n \"Rate\": \"1.00\",\n \"Approver\": \"Cheryl Abrahams\",\n \"OvertimeWorked\": \"1.00\",\n \"OvertimeTimeUnits\": \"Days\",\n \"RateDescription\": \"Standard\"\n }\n ]\n}"}],"_postman_id":"2d8cae3c-6367-43c1-a8ba-d9c9563b52d2"}],"id":"28212c41-20e7-4150-87cf-44dea3157cb8","description":"

This API enables all information from the Time Off In Lieu (TOIL) screen for active and inactive employees to be retrieved.

The identifying key for TOIL is:

PersonAbsenceToilGuid

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCode		Read-only.
UsedTOIL		Read-only.
RemainingTOIL		Read-only.
EmployeeName		Read-only.
PersonAbsenceToilGuid		Read-only.
AbsenceType		Read-only.
WorkedFrom		Read-only.
WorkedTo		Read-only.
Reason		Read-only.
TakenAsPay		Read-only.
TOILEffectiveFrom		Read-only.
TOILExpiry		Read-only.
Notes		Read-only.
TimeUnits		Read-only.
TOILEarned		Read-only.
Status		Read-only.
Rate		Read-only.
Approver		Read-only.
OvertimeWorked		Read-only.
OvertimeTimeUnits		Read-only.
RateDescription		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has no access to this API.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"4ba325f3-4a11-4ad6-b74f-553b6180b960","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cc94288f-2aab-4ab4-9d9b-6fae01c7c064","type":"text/javascript","exec":[""]}}],"_postman_id":"28212c41-20e7-4150-87cf-44dea3157cb8"},{"name":"Absence Types (Read-Only)","item":[{"name":"List of Absence Types","id":"839d236f-337d-40c4-9f05-c8b31b1253a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{url}}/AbsenceTypes?$format=json","description":"

This request will return a list of Absence Type Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["AbsenceTypes"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"22dd27b3-a766-4444-a089-7c65137d2346","name":"List of Absence Types","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":{"raw":"{{url}}/AbsenceTypes?$format=json","host":["{{url}}"],"path":["AbsenceTypes"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Fri, 06 Nov 2020 10:21:34 GMT"},{"key":"Content-Length","value":"461"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#AbsenceTypes\",\n \"value\": [\n {\n \"AbsenceTypeGuid\": \"e0cf26dc-9042-4c18-bbc0-c45867732135\",\n \"Name\": \"Holiday\",\n \"TranslatedName\": \"Holiday\",\n \"Description\": \"Holiday\",\n \"CalendarType\": 1,\n \"EventType\": 1,\n \"Category\": \"Holiday\",\n \"TimeUnits\": \"Days\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2019-11-04T00:00:00Z\",\n \"Colour\": \"#FF50B288\"\n }\n ]\n}"}],"_postman_id":"839d236f-337d-40c4-9f05-c8b31b1253a1"}],"id":"b9b49b20-4f95-4e70-91b1-41c746ccd11f","description":"

This API enables information about Absence Types in the system to be retrieved.

The identifying key for Absence Types is:

AbsenceTypeGuid

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
AbsenceTypeGuid		Key. Read-only.
Name		Read-only.
TranslatedName		Read-only.
Description		Read-only.
CalendarType		Read-only.
EventType		Read-only.
Category		Read-only.
TimeUnits		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
Colour		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to all types within the system.
Restricted HR Professional	Has read-only access to all types within the system.
Line Manager	Has read-only access to all types within the system.
Self Service	Has read-only access to all types within the system.

","event":[{"listen":"prerequest","script":{"id":"a2dcd401-a8d1-4ffd-a96b-fb759cbf7673","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d733b7ca-3cb4-4b92-a8ef-6df4c8896d5b","type":"text/javascript","exec":[""]}}],"_postman_id":"b9b49b20-4f95-4e70-91b1-41c746ccd11f"},{"name":"Absence Type Translations (Read-Only) ","item":[{"name":"List of Absence Type Translations","id":"42baf3bf-01d7-4add-8294-4c1860e81045","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{url}}/AbsenceTypeTranslations?$format=json","description":"

This request will return a list of Absence Type Translations from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["AbsenceTypeTranslations"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"4a82badb-5a63-4bbe-8a11-0c6d5f853e35","name":"List of Absence Type Translations","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":{"raw":"{{url}}/AbsenceTypeTranslations?$format=json","host":["{{url}}"],"path":["AbsenceTypeTranslations"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Fri, 06 Nov 2020 13:39:27 GMT"},{"key":"Content-Length","value":"408"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#AbsenceTypeTranslations\",\n \"value\": [\n {\n \"TranslationGuid\": \"da30ddd0-ce63-47b3-bf11-e94494187fd7\",\n \"LocaleId\": 1031,\n \"LocaleDescription\": \"German (Germany)\",\n \"TranslatedAbsenceTypeName\": \"Elternzeit\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2019-11-04T00:00:00Z\"\n }\n ]\n}"}],"_postman_id":"42baf3bf-01d7-4add-8294-4c1860e81045"}],"id":"a0628505-a158-4350-b162-8916cc997fd3","description":"

This API enables information about Absence Type Translations in the system to be retrieved.

The identifying keys for Absence Type Translations are:

LocaleId
TranslationGuid

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
TranslationGuid		Key. Read-only.
LocaleId		Key. Read-only.
LocaleDescription		Read-only.
TranslatedAbsenceTypeName		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to all type translations within the system.
Restricted HR Professional	Has read-only access to all type translations within the system.
Line Manager	Has read-only access to all type translations within the system.
Self Service	Has read-only access to all type translations within the system.

","event":[{"listen":"prerequest","script":{"id":"6866e075-a28d-4b3e-96e6-f8fb2622cfe2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"70797fa8-a09a-4a4a-ae15-7715c26fafa1","type":"text/javascript","exec":[""]}}],"_postman_id":"a0628505-a158-4350-b162-8916cc997fd3"},{"name":"Absence Type Reasons (Read-Only) ","item":[{"name":"List of Absence Type Reasons","id":"b4adc559-d70d-4375-ba6c-775cddce8755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{url}}/AbsenceTypeReasons?$format=json","description":"

This request will return a list of Absence Reasons which are associated with Absence Types in the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.
In order to retrieve the Name of the Absence Reason, you can link this API to AbsenceTypeReasonsCodeTable using the AbsenceReasonCodeGuid and CodeGuid fields and looking at the CodeDescription field.
If you want to retrieve the translations of an Absence Reason, you can link this API to AbsenceTypeReasonsCodeTableTranslations using the AbsenceReasonCodeGuid and CodeGuid fields and looking at the LocaleDescription and CodeDescription fields.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["AbsenceTypeReasons"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"5b6c294c-e45d-40d9-ab0e-93deb265dae3","name":"List of Absence Type Reasons","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":{"raw":"{{url}}/AbsenceTypeReasons?$format=json","host":["{{url}}"],"path":["AbsenceTypeReasons"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Fri, 06 Nov 2020 13:25:06 GMT"},{"key":"Content-Length","value":"431"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#AbsenceTypeReasons\",\n \"value\": [\n {\n \"AbsenceTypeReasonGuid\": \"9f686a8d-c61d-49e8-b7c6-fa0bee5affe2\",\n \"AbsenceTypeGuid\": \"74f5bfe1-caa3-417d-a8ff-e38ded77105a\",\n \"AbsenceReasonCodeGuid\": \"4b4fd08c-cb48-4fef-9619-a1b071e17f45\",\n \"SortOrder\": 5,\n \"InsertUser\": \"chery;.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"chery;.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2019-11-16T00:00:00Z\"\n }\n ]\n}"}],"_postman_id":"b4adc559-d70d-4375-ba6c-775cddce8755"}],"id":"0a80b324-c269-4ae6-be68-64ca1cf89692","description":"

This API enables information about Absence Reasons associated to Absence Types in the system to be retrieved.

The identifying key for Absence Type Reasons is:

AbsenceTypeReasonGuid

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
AbsenceTypeReasonGuid		Key. Read-only.
AbsenceTypeGuid		Read-only.
AbsenceReasonCodeGuid		Read-only.
SortOrder		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to all type reasons within the system.
Restricted HR Professional	Has full access to all type reasons within the system.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"64ec1b6d-ddab-4ad8-a233-39e672f971f8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6b75d040-e7de-4c5d-bab4-7cf3c83abb8f","type":"text/javascript","exec":[""]}}],"_postman_id":"0a80b324-c269-4ae6-be68-64ca1cf89692"},{"name":"Absence Type Reasons Picklist (Read-Only) ","item":[{"name":"List of Absence Type Reasons Picklist Items","id":"a4a6e6d6-90bd-4788-a6b3-5ce7317f55c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{url}}/AbsenceTypeReasonsCodeTable?$format=json&$top=1","description":"

This request will return a list of Absence Reason picklist entries in the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["AbsenceTypeReasonsCodeTable"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"},{"key":"$top","value":"1"}],"variable":[]}},"response":[{"id":"d1a62cb6-add2-4a57-ae1d-9599a6b5bf11","name":"List of Absence Type Reasons Picklist Items","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":{"raw":"{{url}}/AbsenceTypeReasonsCodeTable?$format=json","host":["{{url}}"],"path":["AbsenceTypeReasonsCodeTable"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Fri, 06 Nov 2020 13:28:51 GMT"},{"key":"Content-Length","value":"343"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#AbsenceTypeReasonsCodeTable\",\n \"value\": [\n {\n \"CodeGuid\": \"988d78a2-c91e-4c79-9d03-ea24daa622c8\",\n \"Code\": \"SickLT\",\n \"CodeDescription\": \"Sickness (Long Term)\",\n \"SortOrder\": 10,\n \"Inactive\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2019-11-04T11:59:20.78Z\"\n }\n ]\n}"}],"_postman_id":"a4a6e6d6-90bd-4788-a6b3-5ce7317f55c7"}],"id":"461e3311-1479-49a1-bbfe-d0b0cef16fc1","description":"

This API enables information about entries from the Absence Reasons picklist in the system to be retrieved.

The identifying key for Absence Type Reasons Picklist is:

CodeGuid

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
CodeGuid		Key. Read-only.
Code		Read-only.
CodeDescription		Read-only.
SortOrder		Read-only.
Inactive		Read-only. 1 = inactive, 0 = active.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to all reason picklist entries within the system.
Restricted HR Professional	Has read-only access to all reason picklist entries within the system.
Line Manager	Has read-only access to all reason picklist entries within the system.
Self Service	Has read-only access to all reason picklist entries within the system.

","event":[{"listen":"prerequest","script":{"id":"17ae7e28-8fa7-4b7e-a53c-c6c269a2b0ae","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4acd5507-574f-4ebe-8f78-c58bd81ace00","type":"text/javascript","exec":[""]}}],"_postman_id":"461e3311-1479-49a1-bbfe-d0b0cef16fc1"},{"name":"Absence Type Reasons Translations (Read-Only) ","item":[{"name":"List of Absence Type Reasons Translations","id":"488c8c59-4239-4171-869f-d0ada53de94b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{url}}/AbsenceTypeReasonsCodeTableTranslations?$format=json","description":"

This request will return a list of Absence Type Reasons tranlsations in the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["AbsenceTypeReasonsCodeTableTranslations"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"9c70d71b-cf0a-43a8-9bf5-f4b34596496c","name":"List of Absence Type Reasons Translations","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":{"raw":"{{url}}/AbsenceTypeReasonsCodeTableTranslations?$format=json","host":["{{url}}"],"path":["AbsenceTypeReasonsCodeTableTranslations"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Fri, 06 Nov 2020 13:33:56 GMT"},{"key":"Content-Length","value":"382"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#AbsenceTypeReasonsCodeTableTranslations\",\n \"value\": [\n {\n \"CodeGuid\": \"0e187e31-f1cb-4ed3-b883-f3c00e0e5ddd\",\n \"LocaleID\": 1031,\n \"LocaleDescription\": \"German (Germany)\",\n \"CodeDescription\": \"Krankheit (Langzeit)\",\n \"Code\": \"SickLT\",\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2019-11-04T11:59:20.78Z\"\n }\n ]\n}"},{"id":"d1ab4ef8-07fc-45f4-af4f-96b3abf343b3","name":"List of Absence Type Reasons Picklist Items","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer Your-API-Token","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":{"raw":"{{url}}/AbsenceTypeReasonsCodeTable?$format=json","host":["{{url}}"],"path":["AbsenceTypeReasonsCodeTable"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"DataServiceVersion","value":"3.0;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Date","value":"Fri, 06 Nov 2020 13:28:51 GMT"},{"key":"Content-Length","value":"343"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#AbsenceTypeReasonsCodeTable\",\n \"value\": [\n {\n \"CodeGuid\": \"988d78a2-c91e-4c79-9d03-ea24daa622c8\",\n \"Code\": \"SickLT\",\n \"CodeDescription\": \"Sickness (Long Term)\",\n \"SortOrder\": 10,\n \"Inactive\": 0,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2019-11-04T11:59:20.78Z\"\n }\n ]\n}"}],"_postman_id":"488c8c59-4239-4171-869f-d0ada53de94b"}],"id":"579e1d2d-5fef-413f-be55-28cb61e50d58","description":"

This API enables information about the translations of entries from the Absence Reasons picklist in the system to be retrieved.

The identifying keys for Absence Type Reasons Translations are:

CodeGuid
LocaleID

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
CodeGuid		Key. Read-only.
LocaleID		Key. Read-only.
LocaleDescription		Read-only.
CodeDescription		Read-only.
Code		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to all reason translations within the system.
Restricted HR Professional	Has read-only access to all reason translations within the system.
Line Manager	Has read-only access to all reason translations within the system.
Self Service	Has read-only access to all reason translations within the system.

","event":[{"listen":"prerequest","script":{"id":"af1840c2-42c1-46dc-b4e6-e2b1d4a764bc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d7d82e9a-06bc-404e-8632-d1fe8a2cbc96","type":"text/javascript","exec":[""]}}],"_postman_id":"579e1d2d-5fef-413f-be55-28cb61e50d58"}],"id":"b71b1acd-2c4c-5e83-d7c5-9dfab1c2531f","_postman_id":"b71b1acd-2c4c-5e83-d7c5-9dfab1c2531f","description":""},{"name":"Compensation and Benefits","item":[{"name":"Benefits","item":[{"name":"List of Employee Benefits","id":"86e6244b-2909-ccdc-85f8-f8acb3aaa0fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Benefits?$format=json","description":"

This request will return a list of Employee Benefits from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Benefits"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"1ad5090f-5c10-7f30-855f-21edcbea9176","name":"List of Employee Benefits","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/Benefits?$format=json","host":["{{url}}"],"path":["Benefits"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"748","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Thu, 27 Jul 2017 13:38:45 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"605","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Benefits\",\n \"value\": [\n {\n \"PersonBenefitCode\": \"cbba5def-f666-990e-b4fa-6e888b670e2b\",\n \"PersonGUID\": \"05dc20e3-7319-473d-bbe3-cfe18876fc7e\",\n \"PersonCode\": \"107\",\n \"AccountOrMembershipNo\": \"1234567\",\n \"BenefitDescription\": null,\n \"BenefitType\": \"Health Insurance\",\n \"SchemeName\": \"AZA Health Insurance\",\n \"SchemeProvider\": null,\n \"SchemeJoinDate\": \"2014-05-01T00:00:00\",\n \"SchemeLeaveDate\": \"2999-12-31T00:00:00\",\n \"ValidToJoinDate\": null,\n \"SchemeOfferDate\": null,\n \"BenefitsEmploymentID\": null,\n \"AssociatedDocuments\": null,\n \"IssuedToEmployee\": null,\n \"ReturnedByEmployee\": null,\n \"SentToProvider\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2014-05-01T11:25:00.287Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"86e6244b-2909-ccdc-85f8-f8acb3aaa0fc"},{"name":"Add an Employee's Benefits","id":"49f72048-eef2-ac5e-8021-2ec097e82b42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"AccountOrMembershipNo\": \"563689\",\n \"BenefitType\": \"Pension\",\n \"SchemeName\": \"Omnicrom Pension Fund\",\n \"SchemeJoinDate\": \"2017-01-01T00:00:00\",\n \"SchemeLeaveDate\": \"2017-12-31T00:00:00\"\n}"},"url":"{{url}}/Benefits?$format=json","description":"

This request will insert a Benefits record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Benefits"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"728a55d7-93af-ee43-958c-685f9b6e1ced","name":"Add an Employee's Benefits","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"AccountOrMembershipNo\": \"563689\",\n\t\"BenefitType\": \"Pension\",\n\t\"SchemeName\": \"Omnicrom Pension Fund\",\n\t\"SchemeJoinDate\": \"2017-01-01T00:00:00\",\n\t\"SchemeLeaveDate\": \"2017-12-31T00:00:00\"\n}"},"url":{"raw":"{{url}}/Benefits?$format=json","host":["{{url}}"],"path":["Benefits"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"695","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 03 Jan 2018 10:11:05 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/Benefits(PersonCode='26',SchemeJoinDate=datetime'2017-01-01T00%3A00%3A00',SchemeName='Omnicrom%20Pension%20Fund')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"709","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Benefits/@Element\",\n \"PersonBenefitCode\": null,\n \"PersonGUID\": null,\n \"PersonCode\": \"26\",\n \"AccountOrMembershipNo\": \"563689\",\n \"BenefitDescription\": null,\n \"BenefitType\": \"Pension\",\n \"SchemeName\": \"Omnicrom Pension Fund\",\n \"SchemeProvider\": null,\n \"SchemeJoinDate\": \"2017-01-01T00:00:00\",\n \"SchemeLeaveDate\": \"2017-12-31T00:00:00\",\n \"ValidToJoinDate\": null,\n \"SchemeOfferDate\": null,\n \"BenefitsEmploymentID\": null,\n \"AssociatedDocuments\": null,\n \"IssuedToEmployee\": null,\n \"ReturnedByEmployee\": null,\n \"SentToProvider\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:03.8493002Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"49f72048-eef2-ac5e-8021-2ec097e82b42"},{"name":"Update an Employee's Benefits record","id":"f22315b7-c258-4b42-9445-33a3342fd92d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/Benefits(PersonCode='[PersonCode]', SchemeName='[SchemeName]', SchemeJoinDate=datetime'[SchemeJoinDate]')","description":"

This request will update an employee's Benefits record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, SchemeName and SchemeJoinDate cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Benefits(PersonCode='[PersonCode]', SchemeName='[SchemeName]', SchemeJoinDate=datetime'[SchemeJoinDate]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f22315b7-c258-4b42-9445-33a3342fd92d"},{"name":"Delete an Employee's Benefits record","id":"eab87fcc-2992-bcbe-5644-0690dfb9bbb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/Benefits(PersonCode='[PersonCode]', SchemeName='[SchemeName]', SchemeJoinDate=datetime'[SchemeJoinDate]')","description":"

This request will delete an employee's Benefits record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Benefits(PersonCode='[PersonCode]', SchemeName='[SchemeName]', SchemeJoinDate=datetime'[SchemeJoinDate]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eab87fcc-2992-bcbe-5644-0690dfb9bbb9"}],"id":"6d752479-5fc5-3fa8-04f0-b3031a4ffc21","description":"

This API enables all information from the Benefits screen for active and inactive employees to be retrieved and modified.

The identifying keys for Benefits are:

PersonCode
SchemeName
SchemeJoinDate

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonBenefitCode	Y	Read-only.
PersonGUID		Read-only.
PersonCode	Y	Key. Read-only.
AccountOrMembershipNo	Y
BenefitDescription
BenefitType	Y
SchemeName	Y	Key. Read-only.
SchemeProvider
SchemeJoinDate	Y	Key. Read-only.
SchemeLeaveDate	Y
ValidToJoinDate
SchemeOfferDate
BenefitsEmploymentID
AssociatedDocuments
IssuedToEmployee
ReturnedByEmployee
SentToProvider
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"a6650f33-a3d3-4e77-bd90-b4537249ba5b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ebe10f85-2fbc-4fb3-8170-414d0e9f0356","type":"text/javascript","exec":[""]}}],"_postman_id":"6d752479-5fc5-3fa8-04f0-b3031a4ffc21"},{"name":"Benefits - Contributions","item":[{"name":"List of Employee Benefits Contributions","id":"c529eaa3-a271-e4a4-de8d-76b1509555cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/BenefitContributions?$format=json","description":"

This request will return a list of Employee Benefit Contributions from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["BenefitContributions"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"3e51b36f-06e2-a4f0-4f27-9331f70c5629","name":"List of Employee Benefits Contributions","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/BenefitContributions?$format=json","host":["{{url}}"],"path":["BenefitContributions"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1071","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 17:08:08 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"677","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#BenefitContributions\",\n \"value\": [\n {\n \"PersonGUID\": \"786c1e3c-4bb2-456c-8513-01ddb5601132\",\n \"PersonCode\": \"CEZ40\",\n \"BenefitCode\": \"a5018ec6-8ac4-4d3f-a3d8-08d5eb13fdc0\",\n \"EffectiveFrom\": \"2008-06-29T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"BenefitCurrency\": \"EUR\",\n \"BaseCurrency\": \"USD\",\n \"PayPeriod\": \"Monthly\",\n \"EmployerAmount\": \"90.00\",\n \"EmployerAnnualAmount\": \"1080.00\",\n \"EmployeeAmount\": \"180.00\",\n \"EmployeeAnnualAmount\": \"2160.00\",\n \"TotalAmount\": \"270.00\",\n \"TotalAnnualAmount\": \"3240.00\",\n \"TaxableAmount\": null,\n \"TaxableAnnualAmount\": null,\n \"EmployerBaseAmount\": \"90.000000\",\n \"EmployerAnnualBaseAmount\": \"1080.000000\",\n \"EmployeeBaseAmount\": \"180.000000\",\n \"EmployeeAnnualBaseAmount\": \"2160.000000\",\n \"TotalBaseAmount\": \"270.00\",\n \"TotalAnnualBaseAmount\": \"3240.000000\",\n \"TaxableBaseAmount\": null,\n \"TaxableAnnualBaseAmount\": null,\n \"EmployerPercentageOfSalary\": \"3.00\",\n \"EmployeePercentageOfSalary\": \"6.00\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2011-07-28T15:05:01.39Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n }\n ]\n}"}],"_postman_id":"c529eaa3-a271-e4a4-de8d-76b1509555cb"},{"name":"Add an Employee's Benefit Contributions","id":"06a8db3e-8f96-c81b-d38e-9ca46453e0b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"BenefitCode\": \"e15d03db-2db8-4e32-a2b9-0ae7fdebccb5\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"BenefitCurrency\": \"GBP\",\n \"PayPeriod\": \"Monthly\"\n}"},"url":"{{url}}/BenefitContributions?$format=json","description":"

This request will insert a Benefit Contributions record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["BenefitContributions"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"51751ad8-b137-c066-77a9-9b4b3d973a26","name":"Add an Employee's Benefit Contributions","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"BenefitCode\": \"e15d03db-2db8-4e32-a2b9-0ae7fdebccb5\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"BenefitCurrency\": \"GBP\",\n\t\"PayPeriod\": \"Monthly\"\n}"},"url":{"raw":"{{url}}/BenefitContributions?$format=json","host":["{{url}}"],"path":["BenefitContributions"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"965","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 03 Jan 2018 12:25:06 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/BenefitContributions(BenefitCode=guid'e15d03db-2db8-4e32-a2b9-0ae7fdebccb5',EffectiveFrom=datetime'2017-01-01T00%3A00%3A00',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"853","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#BenefitContributions/@Element\",\n \"PersonGUID\": null,\n \"PersonCode\": \"26\",\n \"BenefitCode\": \"e15d03db-2db8-4e32-a2b9-0ae7fdebccb5\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"BenefitCurrency\": \"GBP\",\n \"BaseCurrency\": null,\n \"PayPeriod\": \"Monthly\",\n \"EmployerAmount\": null,\n \"EmployerAnnualAmount\": null,\n \"EmployeeAmount\": null,\n \"EmployeeAnnualAmount\": null,\n \"TotalAmount\": null,\n \"TotalAnnualAmount\": null,\n \"TaxableAmount\": null,\n \"TaxableAnnualAmount\": null,\n \"EmployerBaseAmount\": null,\n \"EmployerAnnualBaseAmount\": null,\n \"EmployeeBaseAmount\": null,\n \"EmployeeAnnualBaseAmount\": null,\n \"TotalBaseAmount\": null,\n \"TotalAnnualBaseAmount\": null,\n \"TaxableBaseAmount\": null,\n \"TaxableAnnualBaseAmount\": null,\n \"EmployerPercentageOfSalary\": null,\n \"EmployeePercentageOfSalary\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:03.8493002Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\"\n}"}],"_postman_id":"06a8db3e-8f96-c81b-d38e-9ca46453e0b6"},{"name":"Update an Employee's Benefit Contributions record","id":"8bd79675-2b15-45af-b90a-d34bb1426f5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/BenefitContributions(PersonCode='[PersonCode]', BenefitCode='[BenefitCode]', EffectiveFrom=datetime'[EffectiveFrom]')","description":"

This request will update an employee's Benefit Contributions record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, BenefitCode and EffectiveFrom cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["BenefitContributions(PersonCode='[PersonCode]', BenefitCode='[BenefitCode]', EffectiveFrom=datetime'[EffectiveFrom]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8bd79675-2b15-45af-b90a-d34bb1426f5f"},{"name":"Delete an Employee's Benefit Contributions record","id":"c0441550-b866-b248-e726-80a63551d607","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/BenefitContributions(PersonCode='[PersonCode]', BenefitCode='[BenefitCode]', EffectiveFrom=datetime'[EffectiveFrom]')","description":"

This request will delete an employee's Benefit Contributions record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables all information from the Contributions tab on the Benefits screen for active and inactive employees to be retrieved and modified.

The identifying keys for Benefits - Contributions are:

PersonCode
BenefitCode
EffectiveFrom

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonGUID		Read-only.
PersonCode	Y	Key. Read-only.
BenefitCode	Y	Key. Read-only.
EffectiveFrom	Y	Key. Read-only.
EffectiveTo	Y
BenefitCurrency	Y
BaseCurrency		Read-only.
PayPeriod	Y
EmployerAmount
EmployerAnnualAmount		Read-only.
EmployeeAmount
EmployeeAnnualAmount		Read-only.
TotalAmount		Read-only.
TotalAnnualAmount		Read-only.
TaxableAmount
TaxableAnnualAmount		Read-only.
EmployerBaseAmount		Read-only.
EmployerAnnualBaseAmount		Read-only.
EmployeeBaseAmount		Read-only.
EmployeeAnnualBaseAmount		Read-only.
TotalBaseAmount		Read-only.
TotalAnnualBaseAmount		Read-only.
TaxableBaseAmount		Read-only.
TaxableAnnualBaseAmount		Read-only.
EmployerPercentageOfSalary
EmployeePercentageOfSalary
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"40f1aeb6-da68-4be7-b198-2db98269a75b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"95dae0bd-7f64-4366-b5b7-b21e9548a7ca","type":"text/javascript","exec":[""]}}],"_postman_id":"92e06fde-3321-1b02-55a9-8385b44fccd5"},{"name":"Benefits - Beneficiaries","item":[{"name":"List of Employee Benefit Beneficiaries","id":"66ef2afa-9411-eb91-076b-c13f1c1d886c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Beneficiaries?$format=json","description":"

This request will return a list of Employee Benefit Beneficiaries from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Beneficiaries"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"7db87067-9918-7439-3ce8-d62b34d5faf4","name":"List of Employee Benefit Beneficiaries","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/Beneficiaries?$format=json","host":["{{url}}"],"path":["Beneficiaries"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"582","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 17:10:47 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"480","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Beneficiaries\",\n \"value\": [\n {\n \"BenefitCode\": \"e67d33db-2db8-4e32-a2b9-0ae4fdebccb3\",\n \"PersonCode\": \"26\",\n \"Name\": \"Arthur Abrahams\",\n \"RelationshipToEmployee\": \"Spouse\",\n \"EffectiveFrom\": \"2012-11-02T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"PayPeriod\": \"Monthly\",\n \"Currency\": \"GBP\",\n \"BenefitShareAmount\": null,\n \"BenefitSharePercentage\": \"50.00\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2015-07-22T14:26:31.61Z\"\n }\n ]\n}"}],"_postman_id":"66ef2afa-9411-eb91-076b-c13f1c1d886c"},{"name":"Add an Employee's Benefit Beneficiaries","id":"b7db16e7-13cf-8f8c-ab96-829cf2d6f5fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"BenefitCode\": \"e15d03db-2db8-4e32-a2b9-0ae7fdebccb5\",\n \"PersonCode\": \"CEZ44\",\n \"Name\": \"Mark Abrahams\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"PayPeriod\": \"Monthly\",\n \"Currency\": \"GBP\"\n}"},"url":"{{url}}/Beneficiaries?$format=json","description":"

This request will insert a Benefit Beneficiaries record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Beneficiaries"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"b7db16e7-13cf-8f8c-ab96-829cf2d6f5fe"},{"name":"Update an Employee's Benefit Beneficiaries record","id":"1df48b04-f818-4bb6-b832-3e9c9e1f1e59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/Beneficiaries(BenefitCode='[BenefitCode]', Name='[Name]', EffectiveFrom=datetime'[EffectiveFrom]')","description":"

This request will update an employee's Benefit Beneficiaries record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The BenefitCode, Name and EffectiveFrom cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Beneficiaries(BenefitCode='[BenefitCode]', Name='[Name]', EffectiveFrom=datetime'[EffectiveFrom]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1df48b04-f818-4bb6-b832-3e9c9e1f1e59"},{"name":"Delete an Employee's Benefit Beneficiaries record","id":"d2ce214b-54a8-7f3e-5c13-78b91511fdf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/Beneficiaries(BenefitCode='[BenefitCode]', Name='[Name]', EffectiveFrom=datetime'[EffectiveFrom]')","description":"

This request will delete an employee's Benefit Beneficiaries record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Beneficiaries(BenefitCode='[BenefitCode]', Name='[Name]', EffectiveFrom=datetime'[EffectiveFrom]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2ce214b-54a8-7f3e-5c13-78b91511fdf8"}],"id":"38e83e26-0c22-98cc-ec66-179471afd912","description":"

This API enables all information from the Beneficiaries tab on the Benefits screen for active and inactive employees to be retrieved and modified.

The identifying keys for Benefits - Beneficiaries are:

BenefitCode
Name
EffectiveFrom

\n\n

Fields

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Comments
BenefitCode	Y	Key. Read-only.
PersonCode		Read-only.
Name	Y	Key. Read-only.
RelationshipToEmployee
EffectiveFrom	Y	Key. Read-only.
EffectiveTo	Y
PayPeriod	Y
Currency	Y
BenefitShareAmount
BenefitSharePercentage
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"26d147b9-c5b8-4adb-ae16-aedc9d8c79ee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7ff89793-9ccb-4a47-9b2d-281b278852d9","type":"text/javascript","exec":[""]}}],"_postman_id":"38e83e26-0c22-98cc-ec66-179471afd912"},{"name":"Compensation","item":[{"name":"List of Compensation Details Records","id":"d796c849-dd79-80c6-a7f9-2a0f1e80f86a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/Compensation?$format=json","description":"

This request will return a list of Employee Compensation Details from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["Compensation"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"27265b70-e2be-5e89-2f3e-a52d848cdfab","name":"List of Employee Compensation Details Records","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/Compensation?$format=json","host":["{{url}}"],"path":["Compensation"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"content-length","key":"content-length","value":"1719","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Wed, 16 Aug 2017 10:34:21 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"1064","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Compensation\",\n \"value\": [\n {\n \"PersonCompGUID\": \"5a33a67b-224e-4807-b9b9-b444a2c81dc0\",\n \"PersonCode\": \"CEZ01\",\n \"FullName\": \"Cheryl Abrahams\",\n \"CompItem\": \"Annual Bonus\",\n \"CompItemCode\": \"BONUS\",\n \"EffectiveFrom\": \"2007-01-01T00:00:00\",\n \"EffectiveTo\": \"2007-12-31T00:00:00\",\n \"CompensationEmploymentID\": null,\n \"PaymentCurrency\": \"GBP\",\n \"BaseCurrency\": \"EUR\",\n \"PayPeriod\": \"Annual\",\n \"CompItemType\": \"Bonus\",\n \"SinglePayment\": 1,\n \"TargetPercentageAchieved\": \"87.50\",\n \"ChangeReason\": \"Annual Pay Review\",\n \"SinglePaymentDate\": \"2008-01-31T00:00:00\",\n \"NextReviewDate\": null,\n \"Comments\": null,\n \"CurrentAmount\": \"17500.00\",\n \"AnnualAmount\": \"17500.00\",\n \"ChangeFromPreviousAmount\": null,\n \"AnnualChangeFromPreviousAmount\": null,\n \"TargetAmount\": \"20000.00\",\n \"CurrentBaseAmount\": \"26250.000000\",\n \"AnnualBaseAmount\": \"26250.000000\",\n \"ChangeFromPreviousBaseAmount\": null,\n \"AnnualChangeFromPreviousBaseAmount\": null,\n \"TargetBaseAmount\": \"30000.000000\",\n \"CurrentPercentageChange\": null,\n \"BasePercentageChange\": null,\n \"InsertUser\": \"tammy.bell@omnicrom.com\",\n \"LastModifiedDate\": \"2010-09-28T08:49:38.027Z\",\n \"LastModifiedUser\": \"tammy.bell@omnicrom.com\",\n \"Percentage\": null,\n \"BasedOnPersonCompRecordGUID\": null,\n \"BasedOnEffectiveFrom\": null,\n \"BasedOnCompItem\": null,\n \"PreviousPercentage\": null,\n \"ProRataCurrentAmount\": null,\n \"ProRataAnnualAmount\": null,\n \"ProRataBaseCurrentAmount\": null,\n \"ProRataBaseAmount\": null,\n \"ProRataBaseTargetAmount\": null,\n \"ProRataTargetAmount\": null,\n \"FTERatio\": null,\n \"ProRataChangeFromPreviousAmount\": null,\n \"ProRataAnnualChangeFromPreviousAmount\": null,\n \"ProRataCurrentPercentageChange\": null,\n \"ProRataBaseChangeFromPreviousAmount\": null,\n \"ProRataBaseAnnualChangeFromPreviousAmount\": null,\n \"ProRataBasePercentageChange\": null,\n \"CurrentFTERatio\": null,\n \"CurrentGrade\": null\n }\n ]\n}"}],"_postman_id":"d796c849-dd79-80c6-a7f9-2a0f1e80f86a"},{"name":"Add an Employee's Compensation Details","id":"c238bb2d-1f4b-560d-a0c0-6d2024e00141","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCode\": \"26\",\n \"CompItemCode\": \"BASE\",\n \"EffectiveFrom\": \"2017-01-06T00:00:00\",\n \"EffectiveTo\" : \"2017-12-31T00:00:00\",\n \"PaymentCurrency\": \"GBP\"\n}"},"url":"{{url}}/Compensation?$format=json","description":"

This request will insert a Compensation Details record for an employee.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n
PaymentCurrency is only mandatory for 'Standard', 'Pro Rata Using FTE Ratio' and 'Percentage Only'.\n

","urlObject":{"path":["Compensation"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"64260726-3070-5787-e2ea-02eee9c572a2","name":"Add an Employee's Compensation Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"26\",\n\t\"CompItemCode\": \"BASE\",\n\t\"EffectiveFrom\": \"2017-01-06T00:00:00\",\n\t\"EffectiveTo\" : \"2017-12-31T00:00:00\",\n\t\"PaymentCurrency\": \"GBP\"\n}"},"url":{"raw":"{{url}}/Compensation?$format=json","host":["{{url}}"],"path":["Compensation"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"1566","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Wed, 03 Jan 2018 16:11:01 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/Compensation(CompItemCode='BASE',EffectiveFrom=datetime'2017-01-06T00%3A00%3A00',PersonCode='26')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"491","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#Compensation/@Element\",\n \"PersonCompGUID\": null,\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"CompItem\": null,\n \"CompItemCode\": \"BASE\",\n \"EffectiveFrom\": \"2017-01-06T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"CompensationEmploymentID\": null,\n \"PaymentCurrency\": \"GBP\",\n \"BaseCurrency\": null,\n \"PayPeriod\": null,\n \"CompItemType\": null,\n \"SinglePayment\": 0,\n \"TargetPercentageAchieved\": null,\n \"ChangeReason\": null,\n \"SinglePaymentDate\": null,\n \"NextReviewDate\": null,\n \"Comments\": null,\n \"CurrentAmount\": null,\n \"AnnualAmount\": null,\n \"ChangeFromPreviousAmount\": null,\n \"AnnualChangeFromPreviousAmount\": null,\n \"TargetAmount\": null,\n \"CurrentBaseAmount\": null,\n \"AnnualBaseAmount\": null,\n \"ChangeFromPreviousBaseAmount\": null,\n \"AnnualChangeFromPreviousBaseAmount\": null,\n \"TargetBaseAmount\": null,\n \"CurrentPercentageChange\": null,\n \"BasePercentageChange\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:03.5836775Z\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"Percentage\": null,\n \"BasedOnPersonCompRecordGUID\": null,\n \"BasedOnEffectiveFrom\": null,\n \"BasedOnCompItem\": null,\n \"PreviousPercentage\": null,\n \"ProRataCurrentAmount\": null,\n \"ProRataAnnualAmount\": null,\n \"ProRataBaseCurrentAmount\": null,\n \"ProRataBaseAmount\": null,\n \"ProRataBaseTargetAmount\": null,\n \"ProRataTargetAmount\": null,\n \"FTERatio\": null,\n \"ProRataChangeFromPreviousAmount\": null,\n \"ProRataAnnualChangeFromPreviousAmount\": null,\n \"ProRataCurrentPercentageChange\": null,\n \"ProRataBaseChangeFromPreviousAmount\": null,\n \"ProRataBaseAnnualChangeFromPreviousAmount\": null,\n \"ProRataBasePercentageChange\": null\n}"}],"_postman_id":"c238bb2d-1f4b-560d-a0c0-6d2024e00141"},{"name":"Update an Employee's Compensation Details","id":"cd3afcd4-7a4c-4bc8-bd29-83ce40bbf816","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/Compensation(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', CompItemCode='[CompItemCode]')","description":"

This request will update an employee's Compensation Details record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The PersonCode, EffectiveFrom and CompItemCode cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["Compensation(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', CompItemCode='[CompItemCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd3afcd4-7a4c-4bc8-bd29-83ce40bbf816"},{"name":"Delete an Employee's Compensation Details","id":"48b3e669-f0c1-9951-0f9f-6bd36072ac80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/Compensation(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', CompItemCode='[CompItemCode]')","description":"

This request will delete an employee's Compensation Details record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["Compensation(PersonCode='[PersonCode]', EffectiveFrom=datetime'[EffectiveFrom]', CompItemCode='[CompItemCode]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"48b3e669-f0c1-9951-0f9f-6bd36072ac80"}],"id":"7becd6ed-bed8-a085-3d3b-76616e99c74d","description":"

This API enables all information from the All Comp Details screen for active and inactive employees to be retrieved and modified.

The identifying keys for Compensation are:

PersonCode
EffectiveFrom
CompItemCode

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCompGUID		Read-only.
PersonCode	Y	Key.
FullName		Read-only.
CompItem		Read-only.
CompItemCode	Y	Key.
EffectiveFrom	Y	Key.
EffectiveTo	Y
CompensationEmploymentID
PaymentCurrency	Y
BaseCurrency		Read-only.
PayPeriod		Read-only.
CompItemType
SinglePayment		Read-only.
TargetPercentageAchieved
ChangeReason
SinglePaymentDate
NextReviewDate
Comments
CurrentAmount
AnnualAmount		Read-only.
ChangeFromPreviousAmount		Read-only.
AnnualChangeFromPreviousAmount		Read-only.
TargetAmount
CurrentBaseAmount		Read-only.
AnnualBaseAmount		Read-only.
ChangeFromPreviousBaseAmount		Read-only.
AnnualChangeFromPreviousBaseAmount		Read-only.
TargetBaseAmount		Read-only.
CurrentPercentageChange		Read-only.
BasePercentageChange		Read-only.
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
Percentage
BasedOnPersonCompRecordGUID		Read-only.
BasedOnEffectiveFrom		Read-only.
BasedOnCompItem		Read-only.
PreviousPercentage		Read-only.
ProRataCurrentAmount		Read-only.
ProRataAnnualAmount
ProRataBaseCurrentAmount		Read-only.
ProRataBaseAmount		Read-only.
ProRataBaseTargetAmount		Read-only.
ProRataTargetAmount		Read-only.
FTERatio		Read-only.
ProRataChangeFromPreviousAmount		Read-only.
ProRataAnnualChangeFromPreviousAmount		Read-only.
ProRataCurrentPercentageChange		Read-only.
ProRataBaseChangeFromPreviousAmount		Read-only.
ProRataBaseAnnualChangeFromPreviousAmount		Read-only.
ProRataBasePercentageChange		Read-only.
CurrentFTERatio		Read-only.
CurrentGrade		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"070eb073-c8d2-4719-845f-c49ab34589ca","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a2c7f28d-6843-4dca-a4d6-39ab0eb17588","type":"text/javascript","exec":[""]}}],"_postman_id":"7becd6ed-bed8-a085-3d3b-76616e99c74d"},{"name":"Compensation Proposals (Read-Only)","item":[{"name":"List of Compensation Proposal Records","id":"dd6d0c85-f580-e45d-8a1d-7d635b00e406","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/CompensationProposals?$format=json","description":"

This request will return a list of Compensation Proposals from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["CompensationProposals"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"ac396385-e5a8-f3a9-c42d-114361d58330","name":"List of Compensation Proposals","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/CompensationProposals?$format=json","host":["{{url}}"],"path":["CompensationProposals"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1167","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 11:19:49 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"551","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#CompensationProposals\",\n \"value\": [\n {\n \"PersonCode\": \"26\",\n \"FullName\": \"Cheryl Abrahams\",\n \"CompItemDescription\": \"Annual Allowances\",\n \"EffectiveFrom\": \"2016-01-01T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"EmploymentID\": null,\n \"CurrencyCode\": \"AZN\",\n \"BaseCurrencyCode\": \"USD\",\n \"PayPeriodDescription\": \"Year\",\n \"SinglePayment\": 0,\n \"ReviewDate\": \"2016-01-07T00:00:00\",\n \"ChangeFromPreviousPercentageIncrease\": null,\n \"ChangeReasonDescription\": null,\n \"ProposalStatusDescription\": \"2222\",\n \"CurrentOnReviewDateCurrencyCode\": \"AZN\",\n \"CurrentActualForPeriod\": null,\n \"CurrentAnnual\": null,\n \"BaseCurrentActualForPeriod\": null,\n \"BaseCurrentAnnual\": null,\n \"NewActualForPeriodAmount\": null,\n \"NewAnnualAmount\": null,\n \"ChangeFromPreviousAnnual\": null,\n \"ChangeFromPreviousForPeriod\": null,\n \"NewTargetForPeriod\": null,\n \"BaseNewActualForPeriodAmount\": null,\n \"BaseNewTargetAnnual\": null,\n \"BaseChangeFromPreviousForPeriod\": null,\n \"BaseChangeFromPreviousAnnual\": null,\n \"BaseNewTargetForPeriod\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2016-01-06T15:39:12.31Z\"\n }\n ]\n}"}],"_postman_id":"dd6d0c85-f580-e45d-8a1d-7d635b00e406"}],"id":"cea1ea75-91c2-5809-f6f1-7e7e6b0f2f6f","description":"

This API enables all information from the Comp Proposals screen for active and inactive employees to be retrieved.

The identifying keys for Compensation Proposals are:

PersonCode
CompItemDescription
EffectiveFrom

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
FullName		Read-only.
CompItemDescription	Y	Key.
EffectiveFrom	Y	Key.
EffectiveTo	Y	Read-only.
EmploymentID		Read-only.
CurrencyCode	Y	Read-only.
BaseCurrencyCode		Read-only.
PayPeriodDescription		Read-only.
SinglePayment		Read-only. 1 = Ticked, 0 = Not Ticked.
ReviewDate		Read-only.
ChangeFromPreviousPercentageIncrease		Read-only.
ChangeReasonDescription		Read-only.
ProposalStatusDescription	Y	Read-only.
CurrentOnReviewDateCurrencyCode		Read-only.
CurrentActualForPeriod		Read-only.
CurrentAnnual		Read-only.
BaseCurrentActualForPeriod		Read-only.
BaseCurrentAnnual		Read-only.
NewActualForPeriodAmount		Read-only.
NewAnnualAmount		Read-only.
ChangeFromPreviousAnnual		Read-only.
ChangeFromPreviousForPeriod		Read-only.
NewTargetForPeriod		Read-only.
BaseNewActualForPeriodAmount		Read-only.
BaseNewTargetAnnual		Read-only.
BaseChangeFromPreviousForPeriod		Read-only.
BaseChangeFromPreviousAnnual		Read-only.
BaseNewTargetForPeriod		Read-only.
Comments		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has read-only access to everyone within the system.
Restricted HR Professional	Has read-only access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has no access to this API.

","event":[{"listen":"prerequest","script":{"id":"f5f2f4d9-af73-4b6d-bba2-39c2154cdcff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ff876777-8a5b-4045-b815-2bc0088d775a","type":"text/javascript","exec":[""]}}],"_postman_id":"cea1ea75-91c2-5809-f6f1-7e7e6b0f2f6f"},{"name":"Pension Auto Enrolment","item":[{"name":"List of all Employee Pension Auto Enrolment Status","id":"123c7ac4-3d4d-4b07-9949-d18e5d313e8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/PensionAutoEnrolment?$format=json","description":"

This request will return a list of Employee Pension Auto Enrolment Status from the system.

Notes:

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.
For this call, if you have an active subscription to the Payroll Module, you need to use at least version 7 (v7) of the API.
For this call, if you don't have an active subscription to the Payroll Module, you need to use version 6 (v6) or earlier of the API.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["PensionAutoEnrolment"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"3544bf87-f62e-4a78-a9a4-bdedaffea574","name":"List of all Employee Pension Auto Enrolment Status","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/PensionAutoEnrolment?$format=json","host":["{{url}}"],"path":["PensionAutoEnrolment"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"379","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":"The mime type of this content"},{"key":"DataServiceVersion","value":"3.0;","description":"Custom header"},{"key":"Date","value":"Fri, 01 Jun 2018 17:27:58 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PensionAutoEnrolment\",\n \"value\": [\n {\n \"PersonCode\": \"CEZ01\",\n \"FullName\": \"Cheryl Abrahams\",\n \"StatusDate\": \"2018-05-16T00:00:00\",\n \"StatusEndDate\": \"2999-12-31T00:00:00\",\n \"Status\": \"Automatic\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2018-06-01T17:26:22.117Z\"\n \"UKWorker\": \"Yes\",\n \"DaysToDeferAssessment\": null,\n \"DeferTimeUnit\": null,\n \"AeExclusionReason\": null,\n \"AePostponementLetterSent\": null,\n \"Exempt\": 0,\n \"EmploymentIDRelated\": \"123\",\n \"TranslatedCompanyNameRelated\": \"Omnicrom UK\",\n \"PayrollCode\": \"123\"\n }\n ]\n}"}],"_postman_id":"123c7ac4-3d4d-4b07-9949-d18e5d313e8b"},{"name":"Add an Employee's Pension Auto Enrolment Status","id":"9697bff6-0081-4156-b69a-4335070711dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"CEZ01\",\n\t\"StatusDate\": \"2018-05-16\",\n\t\"Status\": \"Auto-enrolled\"\n\t\n}"},"url":"{{url}}/PensionAutoEnrolment?$format=json","description":"

This request will insert Pension Auto Enrolment record for an employee.

Notes:

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
For this call, if you have an active subscription to the Payroll Module, you need to use at least version 7 (v7) of the API.
For this call, if you don't have an active subscription to the Payroll Module, you need to use version 6 (v6) or earlier of the API.

","urlObject":{"path":["PensionAutoEnrolment"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"2c574e42-fedb-4cee-854a-f4d384acd60b","name":"Add an Employee's Pension Auto Enrolment Status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false},{"key":"Authorization","value":"Bearer Your-API-Token","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"PersonCode\": \"CEZ01\",\n\t\"StatusDate\": \"2018-05-16\",\n\t\"Status\": \"Auto-enrolled\"\n\t\n}"},"url":{"raw":"{{url}}/PensionAutoEnrolment?$format=json","host":["{{url}}"],"path":["PensionAutoEnrolment"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"367","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":"Custom header"},{"key":"Date","value":"Fri, 01 Jun 2018 17:26:21 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Location","value":"https://qa.cezanneondemand.com/COD_UPGRADE/v2/DataService.svc/PensionAutoEnrolment(PersonCode='CEZ01',StatusDate=datetime'2018-05-16T00%3A00%3A00')","name":"Location","description":"Used in redirection, or when a new resource has been created."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"}],"cookie":[],"responseTime":null,"body":"{\n \"odata.metadata\": \"{{url}}/$metadata#PensionAutoEnrolment/@Element\",\n \"PersonCode\": \"CEZ01\",\n \"FullName\": null,\n \"StatusDate\": \"2018-05-16T00:00:00\",\n \"StatusEndDate\": \"2999-12-31T00:00:00\",\n \"Status\": \"Auto-enrolled\",\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2018-06-01T15:13:30.3441456Z\"\n}"}],"_postman_id":"9697bff6-0081-4156-b69a-4335070711dc"},{"name":"Update an Employee's Pension Auto Enrolment Status","id":"c904c7f8-426e-4aed-809d-825a08f78c87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/PensionAutoEnrolment(PersonCode='[PersonCode]', StatusDate=datetime'[StatusDate]', EmploymentIDRelated='[EmploymentIDRelated]')","description":"

This request will update an employee's Pension Auto Enrolment record.

Notes:

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only.
The PersonCode, EmploymentIDRelated and StatusDate cannot be updated as they are the the key fields for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
For this call, if you have an active subscription to the Payroll Module, you need to use at least version 7 (v7) of the API.
For this call, if you don't have an active subscription to the Payroll Module, you need to use version 6 (v6) or earlier of the API.

","urlObject":{"path":["PensionAutoEnrolment(PersonCode='[PersonCode]', StatusDate=datetime'[StatusDate]', EmploymentIDRelated='[EmploymentIDRelated]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c904c7f8-426e-4aed-809d-825a08f78c87"},{"name":"Delete an Employee's Pension Auto Enrolment Status","id":"5a51c966-20b8-4aee-9183-987640ef1e0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Your-API-Token"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/PensionAutoEnrolment(PersonCode='[PersonCode]', StatusDate=datetime'[StatusDate]', EmploymentIDRelated='[EmploymentIDRelated]')","description":"

This request will delete an employee's Pension Auto Enrolment record.

Notes:

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
For this call, if you have an active subscription to the Payroll Module, you need to use at least version 7 (v7) of the API.
For this call, if you don't have an active subscription to the Payroll Module, you need to use version 6 (v6) or earlier of the API.

This API enables all information from the Employee Pension Auto Enrolment screen for active and inactive employees to be retrieved and modified.

The identifying keys for Pension Auto Enrolment are:

PersonCode
StatusDate
EmploymentIDRelated (v7 onwards)

\n\n

Fields

\n\n

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
FullName
StatusDate	Y	Key.
StatusEndDate
Status
Comments
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
UKWorker
DaysToDeferAssessment
DeferTimeUnit
AeExclusionReason
AePostponementLetterSent		1 = Ticked, 0 = Not Ticked.
Exempt		1 = Ticked, 0 = Not Ticked.
EmploymentIDRelated	Key.
TranslatedCompanyNameRelated
PayrollCode		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has access to people as defined by the user's security policy.
Line Manager	Has read-only access to their and all subordinate records.
Self Service	Has read-only access to their own record.

","event":[{"listen":"prerequest","script":{"id":"3725d01e-4fd2-4724-9ea6-b198c260ff7b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7ce9baef-1991-4937-ad3e-f833e84c6a79","type":"text/javascript","exec":[""]}}],"_postman_id":"ed9c0b46-97ee-4285-8db7-0bf55c8ce52f"}],"id":"ed03ce97-6e60-0b2a-078d-c656a3a5d7cb","_postman_id":"ed03ce97-6e60-0b2a-078d-c656a3a5d7cb","description":""},{"name":"Company Cars","item":[{"name":"Catalogued Company Cars","item":[{"name":"Catalogued Cars","item":[{"name":"List of Catalogued Company Cars","id":"e7e963b1-487f-8d76-8a6c-b80c9f6ce5ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/CataloguedCompanyCars?$format=json","description":"

This request will return a list of Catalogued Company Cars from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["CataloguedCompanyCars"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"30023e08-2e0f-76e5-11dd-444f14380ac2","name":"List of Catalogued Company Cars","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/CataloguedCompanyCars?$format=json","host":["{{url}}"],"path":["CataloguedCompanyCars"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"751","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 16:39:02 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"383","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#CataloguedCompanyCars\",\n \"value\": [\n {\n \"ReferenceKey\": \"12345\",\n \"RegistrationNumber\": null,\n \"Make\": null,\n \"Model\": null,\n \"VehicleType\": null,\n \"EngineSize\": null,\n \"FuelType\": null,\n \"VehicleValue\": null,\n \"BaseVehicleValue\": null,\n \"VehicleValueCurrencyCode\": null,\n \"BaseCurrencyCode\": \"USD\",\n \"P11DValue\": null,\n \"DateFirstRegistered\": null,\n \"CO2EmissionsLevel\": null,\n \"EffectiveFrom\": \"2017-07-31T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"LeasingCompany\": null,\n \"LeasePerMonth\": null,\n \"BaseLeasePerMonth\": null,\n \"LeasePerMonthCurrencyCode\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-07-31T16:38:57.28Z\"\n }\n ]\n}"}],"_postman_id":"e7e963b1-487f-8d76-8a6c-b80c9f6ce5ab"},{"name":"Add a Catalogued Company Car","id":"33c07498-4da4-5f16-266b-c9c5ac54341a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ReferenceKey\": \"Car001\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\" : \"2017-12-31T00:00:00\"\n}"},"url":"{{url}}/CataloguedCompanyCars?$format=json","description":"

This request will insert a Catalogued Company Car record.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

","urlObject":{"path":["CataloguedCompanyCars"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"cfcf7afb-2112-ee24-62fc-33be243cd608","name":"Add a Catalogued Company Car","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"ReferenceKey\": \"Car001\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\" : \"2017-12-31T00:00:00\"\n}"},"url":{"raw":"{{url}}/CataloguedCompanyCars?$format=json","host":["{{url}}"],"path":["CataloguedCompanyCars"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"743","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Thu, 04 Jan 2018 17:29:10 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/CataloguedCompanyCars('Car001')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"615","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#CataloguedCompanyCars/@Element\",\n \"ReferenceKey\": \"Car001\",\n \"RegistrationNumber\": null,\n \"Make\": null,\n \"Model\": null,\n \"VehicleType\": null,\n \"EngineSize\": null,\n \"FuelType\": null,\n \"VehicleValue\": null,\n \"BaseVehicleValue\": null,\n \"VehicleValueCurrencyCode\": null,\n \"BaseCurrencyCode\": null,\n \"P11DValue\": null,\n \"DateFirstRegistered\": null,\n \"CO2EmissionsLevel\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"LeasingCompany\": null,\n \"LeasePerMonth\": null,\n \"BaseLeasePerMonth\": null,\n \"LeasePerMonthCurrencyCode\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:05.0055075Z\"\n}"}],"_postman_id":"33c07498-4da4-5f16-266b-c9c5ac54341a"},{"name":"Update a Catalogued Company Car","id":"d7f958ec-be09-4cd8-9a1e-94191afa414b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Comments\": \"Example Comments\"\n}"},"url":"{{url}}/CataloguedCompanyCars(ReferenceKey='[ReferenceKey]')","description":"

This request will update a Catalogued Company Car record.

\n
\nNotes:\n

The Request body includes only one field as an example. You can add any extra fields from the table that you require. However, some fields are read-only. \n
The ReferenceKey cannot be updated as it is the the key field for this table.
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.

","urlObject":{"path":["CataloguedCompanyCars(ReferenceKey='[ReferenceKey]')"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d7f958ec-be09-4cd8-9a1e-94191afa414b"},{"name":"Delete a Catalogued Company Car","id":"dd6dc5d9-a249-c5b5-1737-ec48abfcba54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/CataloguedCompanyCars(ReferenceKey='[ReferenceKey]')","description":"

This request will delete a Catalogued Company Car record.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n

This API enables information from the Catalogued Company Car Details screen to be retrieved and modified.

The identifying key for Company Cars - Catalouged Company Cars is:

ReferenceKey

\n\n

Fields

\n\n

Field	Mandatory	Comments
ReferenceKey	Y	Key.
RegistrationNumber
Make
Model
VehicleType
EngineSize
FuelType
VehicleValue
BaseVehicleValue		Read-only.
VehicleValueCurrencyCode
BaseCurrencyCode		Read-only.
P11DValue
DateFirstRegistered
CO2EmissionsLevel
EffectiveFrom	Y
EffectiveTo	Y
LeasingCompany
LeasePerMonth
BaseLeasePerMonth		Read-only.
LeasePerMonthCurrencyCode
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Security

\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Role	Comments
HR Professional	Has full access to everyone within the system.
Restricted HR Professional	Has read-only access to all catalogued cars.
Line Manager	Has read-only access to all catalogued cars.
Self Service	Has read-only access to all catalogued cars.

","event":[{"listen":"prerequest","script":{"id":"19bc0f60-5ff7-4129-9e6a-73902f95df49","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2deac76f-4f5e-4455-8abd-bae2616f9765","type":"text/javascript","exec":[""]}}],"_postman_id":"fc651141-c8bd-36db-70d7-fef49d13c17e"},{"name":"Person Assignment","item":[{"name":"List of Catalogued Company Cars Employee Assignment","id":"20958201-ec0a-3c46-aa08-ff0f3ab42fca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":"{{url}}/CataloguedCarAssignment?$format=json","description":"

This request will return a list of Catalogued Cars Employee Assignments from the system.

\n
\nNotes:\n

'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.
We strongly recommend that you use the available parameters below to filter the data you are retrieving.

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

Available Parameters:

$filter
$top
$orderby
$select
$skip
$inlinecount

\n\n

For more information about using the above parameters, see: OData URI Conventions

\n","urlObject":{"path":["CataloguedCarAssignment"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"a13c718e-995c-ac48-6399-e7b1651409ff","name":"List of Catalogued Company Cars Employee Assignment","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your-API-Token"}],"url":{"raw":"{{url}}/CataloguedCarAssignment?$format=json","host":["{{url}}"],"path":["CataloguedCarAssignment"],"query":[{"key":"$format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"814","description":""},{"name":"content-type","key":"content-type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","description":""},{"name":"dataserviceversion","key":"dataserviceversion","value":"3.0;","description":""},{"name":"date","key":"date","value":"Mon, 31 Jul 2017 16:44:30 GMT","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""}],"cookie":[],"responseTime":"508","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#CataloguedCarAssignment\",\n \"value\": [\n {\n \"PersonCompanyCarGUID\": \"6b68d3a1-8800-4b8d-a130-2a4c8b4a5fca\",\n \"PersonCode\": \"71\",\n \"FullName\": \"Curtis Alexander\",\n \"EffectiveFrom\": \"2017-07-31T00:00:00\",\n \"EffectiveTo\": \"2999-12-31T00:00:00\",\n \"CarOwnershipTypeCode\": \"CAT\",\n \"ReferenceKey\": \"12345\",\n \"RegistrationNumber\": null,\n \"Make\": null,\n \"Model\": null,\n \"VehicleType\": null,\n \"EngineSize\": null,\n \"FuelType\": null,\n \"BaseCurrencyCode\": \"USD\",\n \"FuelForPrivateUse\": 0,\n \"EmployeeContribution\": null,\n \"BaseEmployeeContribution\": null,\n \"EmployeeContributionCurrencyCode\": null,\n \"PersonalUsePercent\": null,\n \"OtherDrivers\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-07-31T16:43:56.04Z\",\n \"FirstRegistered\": null\n }\n ]\n}"}],"_postman_id":"20958201-ec0a-3c46-aa08-ff0f3ab42fca"},{"name":"Add a Catalogued Company Cars Employee Assignment","id":"459a7b1c-6eae-8168-502c-4c2e5866827e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PersonCompanyCarGUID\": \"00000000-0000-0000-0000-000000000000\",\n \"PersonCode\": \"26\",\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"CarOwnershipTypeCode\": \"CAT\",\n \"ReferenceKey\": \"Car001\"\n}"},"url":"{{url}}/CataloguedCarAssignment?$format=json","description":"

This request will insert an Employee Assignment record for a Catalogued Company Car.

\n
\nNotes:\n

The Example Request body includes only the fields that are mandatory for import, you can add any extra fields from the table that you require. \n
'Your-API-Token' indicates where you should enter the access token, generated using the Authentication section.\n
To add a new Person Assignment for a Company Car, you need to enter a unique PersonCompanyCarGUID for each new record in the following format: '12345678-1234-1234-1234-123456789101'\n

","urlObject":{"path":["CataloguedCarAssignment"],"host":["{{url}}"],"query":[{"key":"$format","value":"json"}],"variable":[]}},"response":[{"id":"fbac1c7c-6ded-7487-5925-3aebe1f71f61","name":"Add a Catalogued Company Cars Employee Assignment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your-API-Token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"PersonCompanyCarGUID\": \"00000000-0000-0000-0000-000000000000\",\n\t\"PersonCode\": \"26\",\n\t\"EffectiveFrom\": \"2017-01-01T00:00:00\",\n\t\"EffectiveTo\": \"2017-12-31T00:00:00\",\n\t\"CarOwnershipTypeCode\": \"CAT\",\n\t\"ReferenceKey\": \"Car001\"\n}"},"url":{"raw":"{{url}}/CataloguedCarAssignment?$format=json","host":["{{url}}"],"path":["CataloguedCarAssignment"],"query":[{"key":"$format","value":"json"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"792","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;odata=minimalmetadata;streaming=true;charset=utf-8","name":"Content-Type","description":""},{"key":"DataServiceVersion","value":"3.0;","name":"DataServiceVersion","description":""},{"key":"Date","value":"Mon, 08 Jan 2018 14:33:49 GMT","name":"Date","description":""},{"key":"Location","value":"https://showcase.cezanneondemand.com/cezanneondemand/v2/DataService.svc/CataloguedCarAssignment(PersonCode='26',PersonCompanyCarGUID=guid'00000000-0000-0000-0000-000000000000')","name":"Location","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"10FF1C8527C119F7CB4E7C4120B8992C37BA1C8AE5234A9C7292845F5BF38D235F1BB6B2EF2F3728FEB7A384928DF969505638D3077B989C224A35AD3FE86D663EBCCEECF12BB193FF45C084F261369A94F105CDE91537455E5B49C713A694D62D34D7A7888AD9B597BDD3246C7569B4C58B10C159A04F82DF9242075831F7E38CE8DEDD0EEAACDD6CF905FEA56D401CC4DB3789AF82193C78C9A4D6A124EB0BDE5B27B6C1663E44BDFDC68E369CC4FD3AE57BC82F41E15393895D53FCBF45BEF8EE38E5FAC9F414B14AF836AC55E69E37B3A04760F8929B12DD607AB5345FE24508BB570572B35BF0EE26ECE04E899FDAEA1A227AC0432679902DA7737F2B5B8C91E71F7F5A858689E6919028A38ADB","key":"CF_SID"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"-1","key":"CF_SLV"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"showcase.cezanneondemand.com","path":"/","secure":false,"value":"/1cGaxGPTBHcD8RBFPNm12FtDYLb3lMpw7XIBqrYFhv/PCOTAE7wxR40Odzc4CqCBqtAOZUr4ANdr0FCU5+yshc/OebxJq3yb+4ZnDyqpu6AwS+bVPF+pa/xxdPnk2Wb9Paf0Dv+yZV/0G7/d6kslgWPqvC6vBmhi0lGAwQ6OUY=","key":"__RequestVerificationToken_L0NlemFubmVPbkRlbWFuZA__"}],"responseTime":"467","body":"{\n \"odata.metadata\": \"{{url}}/$metadata#CataloguedCarAssignment/@Element\",\n \"PersonCompanyCarGUID\": \"45675457-2345-7452-9567-2243489302434\",\n \"PersonCode\": \"26\",\n \"FullName\": null,\n \"EffectiveFrom\": \"2017-01-01T00:00:00\",\n \"EffectiveTo\": \"2017-12-31T00:00:00\",\n \"CarOwnershipTypeCode\": \"CAT\",\n \"ReferenceKey\": \"Car001\",\n \"RegistrationNumber\": null,\n \"Make\": null,\n \"Model\": null,\n \"VehicleType\": null,\n \"EngineSize\": null,\n \"FuelType\": null,\n \"BaseCurrencyCode\": null,\n \"FuelForPrivateUse\": 0,\n \"EmployeeContribution\": null,\n \"BaseEmployeeContribution\": null,\n \"EmployeeContributionCurrencyCode\": null,\n \"PersonalUsePercent\": null,\n \"OtherDrivers\": null,\n \"Comments\": null,\n \"InsertUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedUser\": \"cheryl.abrahams@omnicrom.com\",\n \"LastModifiedDate\": \"2017-12-16T09:00:05.1305286Z\"\n}"}],"_postman_id":"459a7b1c-6eae-8168-502c-4c2e5866827e"},{"name":"Update a Catalogued Company Cars Employee Assignment","id":"66c79484-bd8d-4894-aeba-49a77a3bb1f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"

Field	Mandatory	Comments
PersonCompanyCarGUID	Y	Key.
PersonCode	Y	Key.
FullName		Read-only.
EffectiveFrom	Y
EffectiveTo	Y
CarOwnershipTypeCode	Y	Read-only.
ReferenceKey	Y
RegistrationNumber		Read-only.
Make		Read-only.
Model		Read-only.
VehicleType		Read-only.
EngineSize		Read-only.
FuelType		Read-only.
BaseCurrencyCode		Read-only.
FuelForPrivateUse		1 = Ticked, 0 = Not Ticked.
EmployeeContribution
BaseEmployeeContribution		Read-only.
EmployeeContributionCurrencyCode
PersonalUsePercent
OtherDrivers
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
FirstRegistered

Field	Mandatory	Comments
CataloguedCarReferenceKey	Y	Key. Read-only.
EffectiveFrom	Y	Key. Read-only.
EffectiveTo	Y
TaxInsuranceType	Y	Key. Read-only.
Group
Provider
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Field	Mandatory	Comments
PersonCalendarEventsGUID	Y	Key. Read-only.
PersonCode	Y	Key. Read-only.
Description
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
EffectiveFromDate	Y
EffectiveToDate	Y
EffectiveFromTime
EffectiveToTime
EventType	Y
AllDay		1 = Ticked, 0 = Not Ticked.
FullName
CalendarEventStatus
CalendarEventStatusCode
CalendarEventStatusApproverGuid
CalendarEventStatusApproverName

Field	Mandatory	Comments
CompanyAdHocEventsGUID	Y	Key. Read-only.
EffectiveFromDate	Y
EffectiveToDate	Y
Title	Y
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate	Y	Read-only.
EffectiveFromTime
EffectiveToTime
AllDay		1 = Ticked, 0 = Not Ticked.
CompanyCode	Y	Key. Read-only.
CompanyLocationCode
CompanyLocationName
PreventAbsence		1 = Ticked, 0 = Not Ticked.
CompanyName
Colour

Security Role	Comments
HR Professional	Has full access to events within the system.
Restricted HR Professional	Has access to events as defined by the user's security policy.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

Field	Mandatory	Comments
OrgUnitAdHocEventsGUID	Y	Key. Read-only.
EffectiveFromDate	Y
EffectiveToDate	Y
Title	Y
Comments
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate	Y	Read-only.
EffectiveFromTime
EffectiveToTime
AllDay		1 = Ticked, 0 = Not Ticked.
OrgUnitCode	Y	Key. Read-only.
PreventAbsence		1 = Ticked, 0 = Not Ticked.
OrgUnitName
Colour

Security Role	Comments
HR Professional	Has full access to every event within the system.
Restricted HR Professional	Has access to events as defined by the user's security policy.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

Field	Mandatory	Comments
ProjectGUID	Y	Read-only.
EffectiveFrom	Y
EffectiveTo	Y
ProjectCode	Y	Key.
ProjectName	Y
TranslatedProjectName		Read-only.
Description
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
TranslatedCompanyName		Read-only.
CompanyCode		Read-only.

Field	Mandatory	Comments
ProjectActivitiesGUID	Y	Read-only.
TimesheetActivityName	Y	Key.
TimesheetActivityTranslatedName		Read-only.
Description
TranslatedDescription		Read-only.
EffectiveFrom	Y
EffectiveTo	Y
ProjectGUID	Y	Read-only.
ProjectCode	Y	Key.
ProjectName		Read-only.
TranslatedProjectName		Read-only.
ActivityType
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
LinkWithAbsenceTimeWorked		1 = Ticked, 0 = Not Ticked

Field	Mandatory	Comments
TimesheetActivityTimeTypeGUID		Read-only.
TimesheetActivityGUID	Y	Key. Read-only.
TimesheetActivityName
TimesheetTimeTypeCode	Y
TimesheetTimeTypeDescription	Y	Key.
SortOrder
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
PayCodeTitle		Read-only.
PayCode		Read-only.
ActivityHourlyRate

Field	Mandatory	Comments
TimesheetPlanTypeGUID		Read-only.
PlanTypeName	Y	Key.
TranslatedPlanTypeName		Read-only.
TimesheetFormatCode	Y	Read-only.
TimesheetFormatDescription		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
ValidateTimesheetEmployeeWTP		Read-only. 1 = Ticked, 0 = Not Ticked.
AutoCreateTimesheets		Read-only. 1 = Ticked, 0 = Not Ticked.
EmailEmployeeOnTaskCreation		Read-only. 1 = Ticked, 0 = Not Ticked.
TimeMustBeEnteredNearestQuarterHour		Read-only. 1 = Ticked, 0 = Not Ticked.
SplitWeeklyTimesheetsForMonthlyRecording		Read-only. 1 = Ticked, 0 = Not Ticked.
PreventTimeAndAbsenceOnSameDay		Read-only. 1 = Ticked, 0 = Not Ticked.
AllowCopyAPreviousWeek		Read-only. 1 = Ticked, 0 = Not Ticked.
LinkWithAbsenceTimeWorked		Read-only. 1 = Ticked, 0 = Not Ticked.
LineManagerCanEdit		Read-only. 1 = Ticked, 0 = Not Ticked.
EmployeesCanEditClockInClockOut		Read-only. 1 = Ticked, 0 = Not Ticked.
LineManagersCanEditClockInClockOut		Read-only. 1 = Ticked, 0 = Not Ticked.
RecordGeolocation		Read-only. 1 = Ticked, 0 = Not Ticked.
RecordIPAddress		Read-only. 1 = Ticked, 0 = Not Ticked.
ArchiveExceptionsAfterDays		Read-only.
ExceptionsLastAutoArchived		Read-only.
TimeZone		Read-only.
EnableOvernightWorking		Read-only. 1 = Ticked, 0 = Not Ticked.
EnableAutomaticBreaks		Read-only. 1 = Ticked, 0 = Not Ticked.
DurationMinutes		Read-only.
EnableManualBreaks		Read-only. 1 = Ticked, 0 = Not Ticked.
DefaultBreakType		Read-only.
ShowClockInClockOutTime		Read-only.
IsActivitiesEnabled		Read-only.

Field	Mandatory	Comments
PersonTimeSheetPlanGUID		Read-only.
TimesheetPlanTypeGUID		Read-only.
TimesheetPlanTypeName	Y	Key.
TimesheetTranslatedPlanTypeName		Read-only.
PersonGUID		Read-only.
PersonCode	Y	Key. Read-only.
EffectiveFrom	Y	Key.
EffectiveTo	Y
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
TimesheetFormat		Read-only.
FullName		Read-only.
TimesheetFormatCode		Read-only.
TimeZone		Read-only.

Field	Mandatory	Comments
PersonTimesheetGUID	Y	Read-only.
PersonGUID	Y	Read-only.
PersonCode	Y	Key. Read-only.
PersonTimesheetPlanGUID	Y	Key. Read-only.
TimesheetTranslatedPlanTypeName	Y	Read-only.
EffetiveFrom	Y	Key. Read-only.
EffectiveTo	Y	Read-only.
TimesheetStatusCode		Read-only.
TimesheetStatusDescription		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
FullName		Read-only.
TimesheetFormatCode		Read-only.
ValidateAgainstEmployeeWTP		Read-only.
TimesheetStatusDate		Read-only.
TimesheetApprover		Read-only. If there is more than one Approver at the stage, this will return 'Multiple'.
ShowClockInClockOutTime		Read-only.

Field	Mandatory	Comments
PersonTimesheetActivityGUID		Read-only.
ProjectActivityGUID	Y	Key.
TimesheetActivityTranslatedName		Read-only.
TimesheetActivityTranslatedDescription		Read-only.
PersonGUID		Read-only.
PersonCode	Y	Key. Read-only.
FullName		Read-only.
EffectiveFrom	Y
EffectiveTo	Y
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
TimesheetActivityType		Read-only.
TimesheetProjectName		Read-only.
TimesheetTranslatedProjectName		Read-only.

Field	Mandatory	Comments
PersonTimesheetDetailGUID	Y	Key. Read-only.
PersonTimesheetGUID	Y	Read-only.
ProjectActivityGUID	Y	Read-only.
PersonCode		Read-only.
FullName		Read-only.
PersonTimesheetActivityGUID	Y	Read-only.
EntryDate	Y	Read-only.
Duration		Read-only.
DurationAsDecimal		Read-only.
StartTime		Read-only.
EndTime		Read-only.
TimesheetComments		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
ActivityName		Read-only.
TimeType		Read-only.
ProjectGUID		Read-only.
ProjectName		Read-only.
ProjectCode		Read-only.
TranslatedProjectName		Read-only.
ActivityType		Read-only.
TimesheetStatus		Read-only.
PaymentApproved		Read-only.
PayCodeGUID		Read-only.
PayCode		Read-only.
ActivityHourlyRate		Read-only.
Paid		Read-only.
Ticked		Read-only.

Security Role	Comments
HR Professional	Has full access to all companies.
Restricted HR Professional	Can read and update all companies.
Line Manager	Has read-only access to all companies.
Self Service	Has read-only access to all companies.

Security Role	Comments
HR Professional	Has full access to all company attributes.
Restricted HR Professional	Has full access to all company attributes.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

Security Role	Comments
HR Professional	Has full access to all org units.
Restricted HR Professional	Has read-only access to all org units.
Line Manager	Has read-only access to all org units.
Self Service	Has read-only access to all org units.

Field	Mandatory	Comments
CostCentreGUID	Y	Read-only. Key.
EffectiveFrom		Read-only.
EffectiveTo		Read-only.
CostCentreCode		Read-only.
CostCentreName		Read-only.
TranslatedCostCentreName		Read-only.
SortOrder		Read-only.
ParentCostCentreGUID		Read-only.
ParentCostCentreCode		Read-only.
ParentCostCentreName		Read-only.
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.

Security Role	Comments
HR Professional	Has read-only access to all cost centres.
Restricted HR Professional	Has read-only access to all cost centres.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

Security Role	Comments
HR Professional	Has full access to all jobs.
Restricted HR Professional	Has read-only access to all jobs.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

Security Role	Comments
HR Professional	Has full access to all positions.
Restricted HR Professional	Has full access to all positions.
Line Manager	Has read-only access to all positions.
Self Service	Has read-only access to all positions.

Field	Mandatory	Comments
PositionGradeGuid	Y	Key.
EffectiveFrom	Y
EffectiveTo	Y
PrimaryGrade	Y
Grade	Y
GradeCode
GradeGroup
PositionTitle
PositionCode	Y
InsertUser		Read-only.
LastModifiedDate		Read-only.
LastModifiedUser		Read-only.
Comments

Security Role	Comments
HR Professional	Has full access to all position grades.
Restricted HR Professional	Has read-only access to all position grades.
Line Manager	Has no access to this API.
Self Service	Has no access to this API.

Field	Mandatory	Comments
ChecklistInstanceGUID		Key. Read-only.
ChecklistStatus		Read-only.
OwnerName		Read-only.
CreatedDate		Read-only.
TargetDate		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
DeadlineDate		Read-only.
PercentageCompleted		Read-only.
FocusPersonCode		Read-only.
ChecklistTemplateName		Read-only.

Security Role	Comments
HR Professional	Has read-only access to all checklists.
Restricted HR Professional	Has read-only access to checklists which they are the owner of.
Line Manager	Has read-only access to checklists which they are the owner of.
Self Service	Has read-only access to checklists which they are the owner of.

Field	Mandatory	Comments
ChecklistTaskGUID		Key. Read-only.
FocusPersonGUID		Read-only.
ChecklistInstanceGUID		Read-only.
Category		Read-only.
AssignedTo		Read-only.
TaskStatus		Read-only.
Deadline		Read-only.
Description		Read-only.
Instructions		Read-only.
Comments		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
ChecklistFocusName		Read-only.
AssignedToSecurityRole		Read-only.
AssignedUser		Read-only.

Field	Mandatory	Comments
NICSummariesGUID	Y	Key. Read-only.
OpeningBalancesGUID	Y	Key. Read-only.
PTToUpperEarningsLimit		Read-only.
LELToPrimaryThreshold		Read-only.
ToLowerEarningsLimit		Read-only.
GrossEarnings		Read-only.
TotalEmployeeNICs		Read-only.
TotalEmployerNICs		Read-only.
NITableCode		Read-only.
NITable		Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.

Field	Mandatory	Comments
PersonCode	Y	Key. Read-only.
AdditionsAndDeductionsGUID	Y	Key. Read-only.
Description	Y	Read-only.
EffectiveFrom	Y	Read-only.
EffectiveTo	Y	Read-only.
OneOffPayment	Y	Read-only.
OneOffDate	Y	Read-only.
MultipleOfHourly	Y	Read-only.
InsertUser		Read-only.
LastModifiedUser		Read-only.
LastModifiedDate		Read-only.
PayCode	Y	Read-only.
PayCodeTitle	Y	Read-only.
PayCodeTypeCode	Y	Read-only.
PayCodeType	Y	Read-only.
PayCodeCalculationCode		Read-only.
PayCodeCalculation		Read-only.
CompanyCodeRelated	Y	Read-only.
PercentageOfNet		Read-only.
PercentageOfBasic		Read-only.
FixedAmount		Read-only.
FixedAmountMultiplier		Read-only.
FixedAmountRate		Read-only.
FixedAmountTotal		Read-only.
HourlyRateMultiplier		Read-only.
PayCodeFixedAmountMultiplierCode		Read-only.
PayCodeFixedAmountMultiplier		Read-only.
TranslatedCompanyNameRelated	Y	Read-only.
EmploymentIDRelated	Y	Read-only.
PayrollCode	Y	Read-only.
ProRate		Read-only.
RegularPaySchedule		Read-only.
ScheduleMultiplier		Read-only.
RegularPayBasis		Read-only.
WTPActiveDaysPerWeek		Read-only.
BaseDayRate		Read-only.
PayResolutionCode		Read-only.
PayResolution		Read-only.
FlexibleWTP		Read-only.
ReducingBalancesInitialBalance		Read-only.
ReducingBalancesPreviouslyPaid		Read-only.
ReducingBalancesPeriodAmount		Read-only.
ReducingBalancesAmountRepaid		Read-only.
ReducingBalancesBalance		Read-only.
ReducingBalancesPaymentsPaused		Read-only.
StatutoryPayment		Read-only.
ChangeReason		Read-only.

Field	Mandatory	Comments
PayrollMileageGuid	Y
PersonCode	Y	Key. Read-only.
FullName
EmploymentIDRelated	Y	Key. Read-only.
TaxYear
PayrunPeriod		Read-only.
NumberOfMilesPayrun		Read-only.
NumberOfMilesYtd		Read-only. 1 = Ticked, 0 = Not Ticked.
AmountPaidPayrun		Read-only. 1 = Ticked, 0 = Not Ticked.
AmountPaidYtd		Read-only. 1 = Ticked, 0 = Not Ticked.
PayrollOptionsVehicleType		Read-only.
Mileage		Read-only.
Date		Read-only. 1 = Ticked, 0 = Not Ticked.
NumberOfPassengers		Read-only.
PassengerAmount		Read-only.
InsertUser		Read-only. 1 = Ticked, 0 = Not Ticked.
LastModifiedUser		Read-only. 1 = Ticked, 0 = Not Ticked.
LastModifiedDate		Read-only. 1 = Ticked, 0 = Not Ticked.
TranslatedCompanyNameRelated		Read-only. 1 = Ticked, 0 = Not Ticked.
PayrollCode		Read-only. 1 = Ticked, 0 = Not Ticked.