POST api/v1/application

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Name	string	Required
Description	string	None.
ApplicationURL	string	None.
IsEnabled	boolean	None.
SupportUrl	string	None.
SupportPhone	string	None.
SupportEmail	string	None.
ImplicitFlowAllowed	boolean	None.
Keys	Collection of OauthKeyRequest	None.
ReplyUrls	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "ApplicationURL": "sample string 3",
  "IsEnabled": true,
  "SupportUrl": "sample string 4",
  "SupportPhone": "sample string 5",
  "SupportEmail": "sample string 6",
  "ImplicitFlowAllowed": true,
  "Keys": [
    {
      "ID": "635394d1-34c1-409a-b807-641d43d6d777",
      "StartDate": "2024-11-03T20:17:53.7389921+00:00",
      "EndDate": "2024-11-03T20:17:53.7389921+00:00"
    },
    {
      "ID": "635394d1-34c1-409a-b807-641d43d6d777",
      "StartDate": "2024-11-03T20:17:53.7389921+00:00",
      "EndDate": "2024-11-03T20:17:53.7389921+00:00"
    }
  ],
  "ReplyUrls": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ApplicationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Request">
  <ApplicationURL>sample string 3</ApplicationURL>
  <Description>sample string 2</Description>
  <ImplicitFlowAllowed>true</ImplicitFlowAllowed>
  <IsEnabled>true</IsEnabled>
  <Keys>
    <OauthKeyRequest>
      <EndDate>2024-11-03T20:17:53.7389921+00:00</EndDate>
      <ID>635394d1-34c1-409a-b807-641d43d6d777</ID>
      <StartDate>2024-11-03T20:17:53.7389921+00:00</StartDate>
    </OauthKeyRequest>
    <OauthKeyRequest>
      <EndDate>2024-11-03T20:17:53.7389921+00:00</EndDate>
      <ID>635394d1-34c1-409a-b807-641d43d6d777</ID>
      <StartDate>2024-11-03T20:17:53.7389921+00:00</StartDate>
    </OauthKeyRequest>
  </Keys>
  <Name i:nil="true" />
  <ReplyUrls xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReplyUrls>
  <SupportEmail>sample string 6</SupportEmail>
  <SupportPhone>sample string 5</SupportPhone>
  <SupportUrl>sample string 4</SupportUrl>
  <Name>sample string 1</Name>
</ApplicationRequest>

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

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

ApplicationResponse

Name	Type	Additional information
ID	string	None.
External_ID	string	None.
Name	string	None.
Description	string	None.
ApplicationURL	string	None.
Created	date	None.
Updated	date	None.
IsEnabled	boolean	None.
SupportUrl	string	None.
SupportPhone	string	None.
SupportEmail	string	None.
ImplicitFlowAllowed	boolean	None.
Keys	Collection of OauthKeyResponse	None.
ReplyUrls	Collection of string	None.
_meta	ResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "sample string 1",
  "External_ID": "sample string 2",
  "Name": "sample string 3",
  "Description": "sample string 4",
  "ApplicationURL": "sample string 5",
  "Created": "2024-11-03T20:17:53.7546077+00:00",
  "Updated": "2024-11-03T20:17:53.7546077+00:00",
  "IsEnabled": true,
  "SupportUrl": "sample string 7",
  "SupportPhone": "sample string 8",
  "SupportEmail": "sample string 9",
  "ImplicitFlowAllowed": true,
  "Keys": [
    {
      "ID": "59a91547-65c3-4d99-ab46-381aa25984ad",
      "StartDate": "2024-11-03T20:17:53.7546077+00:00",
      "EndDate": "2024-11-03T20:17:53.7546077+00:00",
      "Value": "sample string 1",
      "_meta": {
        "Messages": [
          "sample string 1",
          "sample string 2"
        ],
        "ChangeType": "Created"
      }
    },
    {
      "ID": "59a91547-65c3-4d99-ab46-381aa25984ad",
      "StartDate": "2024-11-03T20:17:53.7546077+00:00",
      "EndDate": "2024-11-03T20:17:53.7546077+00:00",
      "Value": "sample string 1",
      "_meta": {
        "Messages": [
          "sample string 1",
          "sample string 2"
        ],
        "ChangeType": "Created"
      }
    }
  ],
  "ReplyUrls": [
    "sample string 1",
    "sample string 2"
  ],
  "_meta": {
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "ChangeType": "Created"
  }
}

application/xml, text/xml

Sample:

<ApplicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Response">
  <ApplicationURL>sample string 5</ApplicationURL>
  <Created>2024-11-03T20:17:53.7546077+00:00</Created>
  <Description>sample string 4</Description>
  <External_ID>sample string 2</External_ID>
  <ID>sample string 1</ID>
  <ImplicitFlowAllowed>true</ImplicitFlowAllowed>
  <IsEnabled>true</IsEnabled>
  <Keys>
    <OauthKeyResponse>
      <EndDate>2024-11-03T20:17:53.7546077+00:00</EndDate>
      <ID>59a91547-65c3-4d99-ab46-381aa25984ad</ID>
      <StartDate>2024-11-03T20:17:53.7546077+00:00</StartDate>
      <Value>sample string 1</Value>
      <_meta>
        <ChangeType>Created</ChangeType>
        <Messages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Messages>
      </_meta>
    </OauthKeyResponse>
    <OauthKeyResponse>
      <EndDate>2024-11-03T20:17:53.7546077+00:00</EndDate>
      <ID>59a91547-65c3-4d99-ab46-381aa25984ad</ID>
      <StartDate>2024-11-03T20:17:53.7546077+00:00</StartDate>
      <Value>sample string 1</Value>
      <_meta>
        <ChangeType>Created</ChangeType>
        <Messages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Messages>
      </_meta>
    </OauthKeyResponse>
  </Keys>
  <Name>sample string 3</Name>
  <ReplyUrls xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReplyUrls>
  <SupportEmail>sample string 9</SupportEmail>
  <SupportPhone>sample string 8</SupportPhone>
  <SupportUrl>sample string 7</SupportUrl>
  <Updated>2024-11-03T20:17:53.7546077+00:00</Updated>
  <_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>
</ApplicationResponse>

multipart/form-data

Sample:

image/png

Sample:

image/jpg

Sample:

image/jpeg

Sample:

image/bmp

Sample: