POST | /api/gateways | Register a gateway. | Register a gateway in the system. The Name property specifies the name of the gateway. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GatewayGuid | body | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | 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 HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"name": "String"
}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "gatewayGuid": "00000000000000000000000000000000", "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }