POST api/superadmin/settings/api-keys

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
KeyName	string	Required
KeyType	string	Required
KeyValue	string	Required
IsActive	boolean	None.
Description	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "KeyName": "sample string 1",
  "KeyType": "sample string 2",
  "KeyValue": "sample string 3",
  "IsActive": true,
  "Description": "sample string 5"
}

application/xml, text/xml

Sample:

<ApiKeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Description>sample string 5</Description>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <KeyName>sample string 1</KeyName>
  <KeyType>sample string 2</KeyType>
  <KeyValue>sample string 3</KeyValue>
</ApiKeyRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ApiKeyRequest'.

Response Information

Resource Description

ApiKeyResult

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
KeyId	integer	None.
KeyName	string	None.
MaskedKey	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "KeyId": 3,
  "KeyName": "sample string 4",
  "MaskedKey": "sample string 5"
}

application/xml, text/xml

Sample:

<ApiKeyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <KeyId>3</KeyId>
  <KeyName>sample string 4</KeyName>
  <MaskedKey>sample string 5</MaskedKey>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ApiKeyResult>