POST api/v7/EncryptionKey

Add new Encryption Key/Value pair.

Request Information

URI Parameters

None.

Body Parameters

Encryption KeyCode and KeyValue to be added

EncryptionKey
NameDescriptionTypeRequired?Additional information
KeyCode *

Unique Key Code to represent Encryption Key

string

Yes

String length: between 1 and 50, inclusive

KeyValue *

The Encryption Key Value

Collection of byte

Yes

None.

Request Formats

application/json, text/json

Sample:
{
  "KeyCode": "sample string 1",
  "KeyValue": "QEA="
}

application/xml, text/xml

Sample:
<EncryptionKeyDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <KeyCode>sample string 1</KeyCode>
  <KeyValue>QEA=</KeyValue>
</EncryptionKeyDto>

Response Information

Resource Description

Returns a HTTPResponse Message stating the success/failure of API Action

HttpResponseMessage
NameDescriptionType
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of Object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean