Ping

GET 
/ping

Used to check uptime

Request

Responses

200

Empty response

application/json

Schema

Schema

object
property name* any

Example (from schema)

{}

400

Bad request

application/json

Schema

Schema

errors

object[]

required

Array [

description stringrequired

Possible values: non-empty and <= 100 characters

details string

Possible values: non-empty and <= 100 characters

reasonCode REASON_CODE (string)required

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

recoverable booleanrequired

source stringrequired

Possible values: non-empty and <= 100 characters

]

Example (from schema)

{
  "errors": [
    {
      "description": "string",
      "details": "string",
      "reasonCode": "BAD_REQUEST",
      "recoverable": true,
      "source": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "source": "Engagement Services",
      "reasonCode": "BAD_REQUEST",
      "description": "Bad input parameter",
      "recoverable": false
    }
  ]
}

503

Service unavailable

application/json

Schema

Schema

errors

object[]

required

Array [

description stringrequired

Possible values: non-empty and <= 100 characters

details string

Possible values: non-empty and <= 100 characters

reasonCode REASON_CODE (string)required

Possible values: [BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, METHOD_NOT_ALLOWED, UNSUPPORTED_MEDIA_TYPE]

recoverable booleanrequired

source stringrequired

Possible values: non-empty and <= 100 characters

]

Example (from schema)

{
  "errors": [
    {
      "description": "string",
      "details": "string",
      "reasonCode": "BAD_REQUEST",
      "recoverable": true,
      "source": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "source": "Engagement Services",
      "reasonCode": "INTERNAL_SERVER_ERROR",
      "description": "Service unavailable",
      "details": "Service is unavailable",
      "recoverable": false
    }
  ]
}

Loading...