POST | /api/gateways/{GatewayName} | Creates a gateway instance. | Replaces RegisterGateway. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GatewayName | path | String | Yes | Identifies the gateway instance. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GatewayGuid | form | Guid | No | |
RegisteredByUser | form | string | No | |
RegisteredOn | form | DateTime | No | |
GatewayStatus | form | int | No | |
GatewayName | form | string | No | |
IPAddress | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/gateways/{GatewayName} HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"gatewayName": "String"
}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } }, "gatewayGuid": "00000000000000000000000000000000", "registeredByUser": "String", "registeredOn": "0001-01-01T00:00:00Z", "gatewayStatus": 0, "gatewayName": "String", "ipAddress": "String" }