POST api/Gateways/{AppID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| AppID | integer |
Required |
Body Parameters
Collection of GWData| Name | Description | Type | Additional information |
|---|---|---|---|
| affiliateid | integer |
None. |
|
| gateway | string |
None. |
|
| fields | Collection of GWField |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"affiliateid": 1,
"gateway": "sample string 2",
"fields": [
{
"name": "sample string 1",
"value": "sample string 2"
},
{
"name": "sample string 1",
"value": "sample string 2"
}
]
},
{
"affiliateid": 1,
"gateway": "sample string 2",
"fields": [
{
"name": "sample string 1",
"value": "sample string 2"
},
{
"name": "sample string 1",
"value": "sample string 2"
}
]
}
]
text/html
Sample:
[{"affiliateid":1,"gateway":"sample string 2","fields":[{"name":"sample string 1","value":"sample string 2"},{"name":"sample string 1","value":"sample string 2"}]},{"affiliateid":1,"gateway":"sample string 2","fields":[{"name":"sample string 1","value":"sample string 2"},{"name":"sample string 1","value":"sample string 2"}]}]
application/xml, text/xml
Sample:
<ArrayOfGWData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRMAPI.Models">
<GWData>
<affiliateid>1</affiliateid>
<fields>
<GWField>
<name>sample string 1</name>
<value>sample string 2</value>
</GWField>
<GWField>
<name>sample string 1</name>
<value>sample string 2</value>
</GWField>
</fields>
<gateway>sample string 2</gateway>
</GWData>
<GWData>
<affiliateid>1</affiliateid>
<fields>
<GWField>
<name>sample string 1</name>
<value>sample string 2</value>
</GWField>
<GWField>
<name>sample string 1</name>
<value>sample string 2</value>
</GWField>
</fields>
<gateway>sample string 2</gateway>
</GWData>
</ArrayOfGWData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Gateways| Name | Description | Type | Additional information |
|---|---|---|---|
| appid | integer |
None. |
|
| gateway | string |
None. |
|
| Affiliates | Collection of Affiliate |
None. |
|
| GatewaySettings | Collection of GatewaySetting |
None. |
Response Formats
application/json, text/json
Sample:
{
"appid": 1,
"gateway": "sample string 2",
"Affiliates": [
{
"ID": 1,
"name": "sample string 2"
},
{
"ID": 1,
"name": "sample string 2"
}
],
"GatewaySettings": [
{
"GatewayName": "sample string 1",
"gateway_date": [
"sample string 1",
"sample string 2"
],
"ShowGateway": true,
"GatewayFields": [
{
"DBField": "sample string 1",
"DisplayName": "sample string 2",
"DisplayLabel": "lblsample string 1",
"GWData": [
"sample string 1",
"sample string 2"
]
},
{
"DBField": "sample string 1",
"DisplayName": "sample string 2",
"DisplayLabel": "lblsample string 1",
"GWData": [
"sample string 1",
"sample string 2"
]
}
]
},
{
"GatewayName": "sample string 1",
"gateway_date": [
"sample string 1",
"sample string 2"
],
"ShowGateway": true,
"GatewayFields": [
{
"DBField": "sample string 1",
"DisplayName": "sample string 2",
"DisplayLabel": "lblsample string 1",
"GWData": [
"sample string 1",
"sample string 2"
]
},
{
"DBField": "sample string 1",
"DisplayName": "sample string 2",
"DisplayLabel": "lblsample string 1",
"GWData": [
"sample string 1",
"sample string 2"
]
}
]
}
]
}
text/html
Sample:
{"appid":1,"gateway":"sample string 2","Affiliates":[{"ID":1,"name":"sample string 2"},{"ID":1,"name":"sample string 2"}],"GatewaySettings":[{"GatewayName":"sample string 1","gateway_date":["sample string 1","sample string 2"],"ShowGateway":true,"GatewayFields":[{"DBField":"sample string 1","DisplayName":"sample string 2","DisplayLabel":"lblsample string 1","GWData":["sample string 1","sample string 2"]},{"DBField":"sample string 1","DisplayName":"sample string 2","DisplayLabel":"lblsample string 1","GWData":["sample string 1","sample string 2"]}]},{"GatewayName":"sample string 1","gateway_date":["sample string 1","sample string 2"],"ShowGateway":true,"GatewayFields":[{"DBField":"sample string 1","DisplayName":"sample string 2","DisplayLabel":"lblsample string 1","GWData":["sample string 1","sample string 2"]},{"DBField":"sample string 1","DisplayName":"sample string 2","DisplayLabel":"lblsample string 1","GWData":["sample string 1","sample string 2"]}]}]}
application/xml, text/xml
Sample:
<Gateways xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRMAPI.Models">
<Affiliates>
<Affiliate>
<ID>1</ID>
<name>sample string 2</name>
</Affiliate>
<Affiliate>
<ID>1</ID>
<name>sample string 2</name>
</Affiliate>
</Affiliates>
<GatewaySettings>
<GatewaySetting>
<GatewayFields>
<GatewayField>
<DBField>sample string 1</DBField>
<DisplayName>sample string 2</DisplayName>
<GWData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</GWData>
</GatewayField>
<GatewayField>
<DBField>sample string 1</DBField>
<DisplayName>sample string 2</DisplayName>
<GWData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</GWData>
</GatewayField>
</GatewayFields>
<GatewayName>sample string 1</GatewayName>
<ShowGateway>true</ShowGateway>
<gateway_date xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</gateway_date>
</GatewaySetting>
<GatewaySetting>
<GatewayFields>
<GatewayField>
<DBField>sample string 1</DBField>
<DisplayName>sample string 2</DisplayName>
<GWData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</GWData>
</GatewayField>
<GatewayField>
<DBField>sample string 1</DBField>
<DisplayName>sample string 2</DisplayName>
<GWData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</GWData>
</GatewayField>
</GatewayFields>
<GatewayName>sample string 1</GatewayName>
<ShowGateway>true</ShowGateway>
<gateway_date xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</gateway_date>
</GatewaySetting>
</GatewaySettings>
<appid>1</appid>
<gateway>sample string 2</gateway>
</Gateways>