Overview

DerbySoft Property Connector uses the Ping message to verify your PMS is up and running, and this is an outbound message from DerbySoft to your PMS.


POST https://{your pms endpoint}/ping HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc
Accept-Encoding: gzip
Content-Encoding: gzip
Content-Type: application/json;charset=utf-8



TABLE OF CONTENTS



Request Schema


Element

Type

Occurrence

Description

echoMessage

String

Mandatory

An echo message to be sent out from DerbySoft



Response Schema


Element

Type

Occurrence

Description

echoMessage

String

Mandatory

An echo message response from your PMS



Example

Request

{
  "header": {
    "echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
    "timeStamp": "2018-06-27T17:09:04.674Z",
    "version": "0.1"
  },
  "echoMessage": "Hello"
}


Response-Success

{
  "header": {
    "echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
    "timeStamp": "2018-06-27T17:09:04.674Z",
    "version": "0.1"
  },
  "echoMessage": "I'm alive!"
}

Response-Error

{
  "header": {
    "echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
    "timeStamp": "2018-06-27T17:09:04.674Z",
    "version": "0.1"
  },
  "errorCode": "InvalidField",
  "errorMessage": "Invalid token"
}