CCC API v8.4.0.0

<back to all web services

SearchGateways

The following routes are available for this service:
GET/api/gatewaysGet a paged list of gateways associated with the current User.
SearchGateways Parameters:
NameParameterData TypeRequiredDescription
GatewayNamequeryStringNoThe gateway name to filter by.
PagequeryIntegerNoThe Page number being requested. Defaults to 1.
PageSizequeryIntegerNoThe Page Size returned by the operation. Defaults to 25.
GatewaysPagedResponse Parameters:
NameParameterData TypeRequiredDescription
PageSizebodyIntegerNo
TotalPagesbodyIntegerNo
TotalItemsbodyIntegerNo
CurrentPagebodyIntegerNo
ResultsbodyGateway[]No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Gateway Parameters:
NameParameterData TypeRequiredDescription
GatewayGuidformGuidNo
RegisteredByUserformstringNo
RegisteredOnformDateTimeNo
GatewayStatusformintNo
GatewayNameformstringNo
IPAddressformstringNo

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/gateways HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "pageSize": 0,
  "totalPages": 0,
  "totalItems": 0,
  "currentPage": 0,
  "results": [
    {
      "gatewayGuid": "00000000000000000000000000000000",
      "registeredByUser": "String",
      "registeredOn": "0001-01-01T00:00:00Z",
      "gatewayStatus": 0,
      "gatewayName": "String",
      "ipAddress": "String"
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}