POST Api

Exchanges a consumer ID and consumer secret for an authentication token.

Request Information

URI Parameters

None.

Body Parameters

Consumer secret, consumer key and information about the consumer.

Name	Type	Additional information
Key	string	None.
MandatorId	integer	None.
ClientInfo	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Key": "sample string 1",
  "MandatorId": 2,
  "ClientInfo": "sample string 3"
}

application/xml, text/xml

Sample:

<ApiTokenParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
  <ClientInfo>sample string 3</ClientInfo>
  <Key>sample string 1</Key>
  <MandatorId>2</MandatorId>
</ApiTokenParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The authentication token and its expiration date.

ApiTokenResponse

Name	Description	Type	Additional information
Token		string	None.
Expires		date	None.

Response Formats

application/json, text/json

Sample:

{
  "Token": "sample string 1",
  "Expires": "2024-08-21T08:25:25.4146364+02:00"
}

application/xml, text/xml

Sample:

<ApiTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <Expires>2024-08-21T08:25:25.4146364+02:00</Expires>
  <Token>sample string 1</Token>
</ApiTokenResponse>