POST api/Incoming/Settings

Request Information

URI Parameters

None.

Body Parameters

ApiIncomingSettingsRequest
NameDescriptionTypeAdditional information
CustomerId

integer

None.

CustomerCode

string

None.

PartnerKey

string

None.

apiKey

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerId": 1,
  "CustomerCode": "sample string 2",
  "PartnerKey": "sample string 3",
  "apiKey": "sample string 4"
}

application/xml, text/xml

Sample:
<ApiIncomingSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/m5api.Models">
  <CustomerCode>sample string 2</CustomerCode>
  <CustomerId>1</CustomerId>
  <PartnerKey>sample string 3</PartnerKey>
  <apiKey>sample string 4</apiKey>
</ApiIncomingSettingsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiIncomingSettingsResponse
NameDescriptionTypeAdditional information
CustomerId

integer

None.

Topics

Collection of string

None.

errorMsg

string

None.

okMsg

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerId": 1,
  "Topics": [
    "sample string 1",
    "sample string 2"
  ],
  "errorMsg": "sample string 2",
  "okMsg": "sample string 3"
}

application/xml, text/xml

Sample:
<ApiIncomingSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/m5api.Models">
  <CustomerId>1</CustomerId>
  <Topics xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Topics>
  <errorMsg>sample string 2</errorMsg>
  <okMsg>sample string 3</okMsg>
</ApiIncomingSettingsResponse>