GET Api/Mandator/ApiKeys

Gets all API keys for all mandators.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of API keys.

Collection of ApiKeyResponse
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Key

string

None.

MandatorId

integer

None.

IsEnabled

boolean

None.

AccessLevels

Collection of ApiKeyAccessLevel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Key": "sample string 3",
    "MandatorId": 4,
    "IsEnabled": true,
    "AccessLevels": [
      0,
      0
    ]
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "Key": "sample string 3",
    "MandatorId": 4,
    "IsEnabled": true,
    "AccessLevels": [
      0,
      0
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfApiKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <ApiKeyResponse>
    <AccessLevels>
      <ApiKeyAccessLevel>Jobs</ApiKeyAccessLevel>
      <ApiKeyAccessLevel>Jobs</ApiKeyAccessLevel>
    </AccessLevels>
    <Id>1</Id>
    <IsEnabled>true</IsEnabled>
    <Key>sample string 3</Key>
    <MandatorId>4</MandatorId>
    <Name>sample string 2</Name>
  </ApiKeyResponse>
  <ApiKeyResponse>
    <AccessLevels>
      <ApiKeyAccessLevel>Jobs</ApiKeyAccessLevel>
      <ApiKeyAccessLevel>Jobs</ApiKeyAccessLevel>
    </AccessLevels>
    <Id>1</Id>
    <IsEnabled>true</IsEnabled>
    <Key>sample string 3</Key>
    <MandatorId>4</MandatorId>
    <Name>sample string 2</Name>
  </ApiKeyResponse>
</ArrayOfApiKeyResponse>