POST API/ExternalAPIRequests/ProcessExternalAPIRequest

Request Information

URI Parameters

None.

Body Parameters

ExternalAPIRequestsModel
NameDescriptionTypeAdditional information
ID

integer

None.

AccountAPICall

string

None.

ApplicationName

string

None.

ExternalAPICall

string

None.

Payload

string

None.

ResponseCode

integer

None.

ErrorMessage

string

None.

UserId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "AccountAPICall": "sample string 2",
  "ApplicationName": "sample string 3",
  "ExternalAPICall": "sample string 4",
  "Payload": "sample string 5",
  "ResponseCode": 6,
  "ErrorMessage": "sample string 7",
  "UserId": "sample string 8"
}

text/html

Sample:
{"ID":1,"AccountAPICall":"sample string 2","ApplicationName":"sample string 3","ExternalAPICall":"sample string 4","Payload":"sample string 5","ResponseCode":6,"ErrorMessage":"sample string 7","UserId":"sample string 8"}

application/xml, text/xml

Sample:
<ExternalAPIRequestsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BMCBusinessLayer.Models">
  <AccountAPICall>sample string 2</AccountAPICall>
  <ApplicationName>sample string 3</ApplicationName>
  <ErrorMessage>sample string 7</ErrorMessage>
  <ExternalAPICall>sample string 4</ExternalAPICall>
  <ID>1</ID>
  <Payload>sample string 5</Payload>
  <ResponseCode>6</ResponseCode>
  <UserId>sample string 8</UserId>
</ExternalAPIRequestsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>