DELETE Api/Mandator/ApiKey/{apiKeyId}

Deletes a specific API key.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKeyId

The ID of the API key to delete.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

The deleted API key.

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
  ]
}

application/xml, text/xml

Sample: 
<ApiKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <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>