POST api/v1/application/{applicationID}/key

Request Information

URI Parameters

Name	Description	Type	Additional information
applicationID		string	Required

Body Parameters

OauthKeyRequest

Name	Type	Additional information
ID	globally unique identifier	None.
StartDate	date	None.
EndDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": "6b0121e4-30bb-4eb7-b7b0-3e3ad64bff2a",
  "StartDate": "2024-11-07T01:02:32.3013613+00:00",
  "EndDate": "2024-11-07T01:02:32.3013613+00:00"
}

application/xml, text/xml

Sample:

<OauthKeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Request">
  <EndDate>2024-11-07T01:02:32.3013613+00:00</EndDate>
  <ID>6b0121e4-30bb-4eb7-b7b0-3e3ad64bff2a</ID>
  <StartDate>2024-11-07T01:02:32.3013613+00:00</StartDate>
</OauthKeyRequest>

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 'OauthKeyRequest'.

multipart/form-data

Sample:

An exception has occurred while using the formatter 'MultiPartMediaFormat' to generate sample for media type 'multipart/form-data'. Exception message: The media type formatter of type 'MultiPartMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/png

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/png'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpeg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpeg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/bmp

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/bmp'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

Response Information

Resource Description

OauthKeyResponse

Name	Type	Additional information
ID	globally unique identifier	None.
StartDate	date	None.
EndDate	date	None.
Value	string	None.
_meta	ResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "7634cbc6-1630-4bf5-bc36-93b7b9197722",
  "StartDate": "2024-11-07T01:02:32.3013613+00:00",
  "EndDate": "2024-11-07T01:02:32.3013613+00:00",
  "Value": "sample string 1",
  "_meta": {
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "ChangeType": "Created"
  }
}

application/xml, text/xml

Sample:

<OauthKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Response">
  <EndDate>2024-11-07T01:02:32.3013613+00:00</EndDate>
  <ID>7634cbc6-1630-4bf5-bc36-93b7b9197722</ID>
  <StartDate>2024-11-07T01:02:32.3013613+00:00</StartDate>
  <Value>sample string 1</Value>
  <_meta>
    <ChangeType>Created</ChangeType>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
  </_meta>
</OauthKeyResponse>

multipart/form-data

Sample:

image/png

Sample:

image/jpg

Sample:

image/jpeg

Sample:

image/bmp

Sample: