POST Api/Mandator/ApiKey/{apiKeyId}

Updates a specific API key.

Request Information

URI Parameters

Name	Description	Type	Additional information
apiKeyId	The ID of the API key to update.	integer	Required

Body Parameters

The updated information for the API key.

ApiKeyUpdateParameter

Name	Type	Additional information
Name	string	None.
IsEnabled	boolean	None.
AccessLevels	Collection of ApiKeyAccessLevel	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "IsEnabled": true,
  "AccessLevels": [
    0,
    0
  ]
}

application/xml, text/xml

Sample:

<ApiKeyUpdateParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
  <AccessLevels xmlns:d2p1="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
    <d2p1:ApiKeyAccessLevel>Jobs</d2p1:ApiKeyAccessLevel>
    <d2p1:ApiKeyAccessLevel>Jobs</d2p1:ApiKeyAccessLevel>
  </AccessLevels>
  <IsEnabled>true</IsEnabled>
  <Name>sample string 1</Name>
</ApiKeyUpdateParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The updated API key.

ApiKeyResponse

Name	Type	Additional 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>