GET | /api/gateways/services | Get a gateway service by domain. | Get a gateway service for a specific domain. The response will contain specific information needed by the gateway. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Domain | query | String | Yes | Domain to get the gateway service for. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceGuid | body | Guid | No | |
ServiceName | form | string | No | |
MessagingApiUrl | form | string | No | |
GatewaySettingsUrl | form | string | No | |
ServiceCode | form | string | No | |
PrimaryDomain | form | string | No | |
SecondaryDomains | 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.
GET /api/gateways/services HTTP/1.1 Host: api.secure-messaging.com Accept: application/json
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" } }, "serviceGuid": "00000000000000000000000000000000", "serviceName": "String", "messagingApiUrl": "String", "gatewaySettingsUrl": "String", "serviceCode": "String", "primaryDomain": "String", "secondaryDomains": [ "String" ] }