Jump to

• Request
• Response

Head connection status

head

{basePath}/checks/connectionStatus

API to indicate the state of the connection for a specific revenue center for servicing requests from the STS Gen2 cloud endpoints. The value returned is the last known state of the connection at the time of the request and could change at any time.

Request

Supported Media Types

• application/json

Header Parameters

• Simphony-LocRef(required): string
  The location identifier.
• Simphony-OrgShortName(required): string
  The organization identifier.
• Simphony-RvcRef(required): integer
  The revenue center identifier.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Indicates if the location is currently connected.

Headers

• Simphony-POS-Connected: boolean
  Indicate whether connection to POS exists for this revenue center.

400 Response

400 Bad Request

Body ()

Root Schema : ChecksApiProblemDetails

Type: object

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). **Extensions** * posDetails

Show Source

• details: string
  A human-readable explanation specific to this occurrence of the problem.

  Example: The Check provided is not valid.
• instance: string
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  Example: error:check_validation_failure
• posDetails: array posDetails
  (Problem Details Extension) Contains a list of the problem details from the POS System processing the request.
• title: string
  A short, human-readable summary of the problem type.

  Example: Check is invalid.
• type: string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: error:validation

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). \n\n  **Extensions**\n  * posDetails\n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Check is invalid.",
        "details":"The Check provided is not valid.",
        "instance":"error:check_validation_failure",
        "posDetails":[
            {
                "code":"menu_item_invalid",
                "message":"invalid 'definitionSequence' value for menuItem '123'"
            }
        ]
    },
    "properties":{
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"error:validation"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"Check is invalid."
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"The Check provided is not valid."
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "type":"string",
            "example":"error:check_validation_failure"
        },
        "posDetails":{
            "description":"(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "code":{
                        "description":"Short, unique identifier for the type of error",
                        "type":"string",
                        "example":"menu_item_invalid"
                    },
                    "message":{
                        "description":"A human-readable explanation specific to this occurrence of the problem.",
                        "type":"string",
                        "example":"invalid 'definitionSequence' value for menuItem '123'"
                    }
                }
            }
        }
    }
}

Example:

{
    "type":"error:validation",
    "title":"Check is invalid.",
    "details":"The Check provided is not valid.",
    "instance":"error:check_validation_failure",
    "posDetails":[
        {
            "code":"menu_item_invalid",
            "message":"invalid 'definitionSequence' value for menuItem '123'"
        }
    ]
}

Nested Schema : posDetails

Type: array

(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.

Show Source

• Array of: object items

{
    "description":"(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "code":{
                "description":"Short, unique identifier for the type of error",
                "type":"string",
                "example":"menu_item_invalid"
            },
            "message":{
                "description":"A human-readable explanation specific to this occurrence of the problem.",
                "type":"string",
                "example":"invalid 'definitionSequence' value for menuItem '123'"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code: string
  Short, unique identifier for the type of error

  Example: menu_item_invalid
• message: string
  A human-readable explanation specific to this occurrence of the problem.

  Example: invalid 'definitionSequence' value for menuItem '123'

{
    "type":"object",
    "properties":{
        "code":{
            "description":"Short, unique identifier for the type of error",
            "type":"string",
            "example":"menu_item_invalid"
        },
        "message":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"invalid 'definitionSequence' value for menuItem '123'"
        }
    }
}

Back to Top