Payload Information:

Within the header of the post request please add "Accept" with one of the following values "application/json", "application/xml", "application/html"

Within the body of the request the following payload must be added. The parameters differ per method but the xml structure remains the same for all methods. Add the parameters below into the Parameters section of the xml. Please note that the xml for the body has a tag called Header this is not the same as the request header.

<CivicaHRPWebApi>
  <Header>
      <InvokeType>Test</InvokeType>
      <Application>HR Unity Online</Application>
      <Licence>Valid Developer Licence</Licence>
      <LoggedInUser></LoggedInUser>
      <UserKey></UserKey>
  </Header>
  <Parameters>
    Appropriate parameters
  </Parameters>
</CivicaHRPWebApi>

POST api/GetUserToken

Get documents

Request Information

Payload

Name	Payload Parameters	Additional information
Parameters		None.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "UserKey": "sample string 1",
  "UserKeyExpires": "2025-11-03T14:09:34.38795+00:00",
  "IsExpired": true,
  "IsAPIUser": true
}

text/html

Sample:

{"UserKey":"sample string 1","UserKeyExpires":"2025-11-03T14:09:34.38795+00:00","IsExpired":true,"IsAPIUser":true}

application/xml, text/xml

Sample:

<UserToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Carval.SelfService.BLL.Common">
  <IsAPIUser>true</IsAPIUser>
  <IsExpired>true</IsExpired>
  <UserKey>sample string 1</UserKey>
  <UserKeyExpires>2025-11-03T14:09:34.38795+00:00</UserKeyExpires>
</UserToken>

Payload Information:

POST api/GetUserToken

Request Information

Payload

Response Information

Response body formats

application/json, text/json

text/html

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body