POST api/app/endpoint/{provider}

Proxy Endpoint For Authenticated Requests To External Providers Based on the External Provider the app is associated with, Authentication is taken care of by the service Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
provider

The provider value supplied with the request.

 string

Required

Body Parameters

The external provider proxy request data contract supplied with the request.

ExternalProviderProxyRequestDataContract
NameDescriptionTypeAdditional information
BrandId

The unique identifier of the related brand resource.

 integer

None.
Method

The method value.

 string

None.
QueryString

The query string value.

 string

None.
Data

The data value.

 string

None.
TimeOutSeconds

The time out seconds value.

 integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample: 
{
  "BrandId": 1,
  "Method": "sample string 2",
  "QueryString": "sample string 3",
  "Data": "sample string 4",
  "TimeOutSeconds": 5
}

Response Information

Resource Description

The response given by the external api

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

The version value.

 Version

None.
Content

The content value.

 HttpContent

None.
StatusCode

The status code classification.

 HttpStatusCode

None.
ReasonPhrase

The reason phrase value.

 string

None.
Headers

The collection of headers.

 Collection of Object

None.
RequestMessage

The request message value.

 HttpRequestMessage

None.
IsSuccessStatusCode

Indicates whether this item is success status code.

 boolean

None.