Mews · Example Payload

Mews Companionships Getall Example

HospitalityHotelsPMSProperty Management

Mews Companionships Getall Example is an example object payload from Mews, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "companionships_getAll",
  "method": "POST",
  "path": "/api/connector/v1/companionships/getAll",
  "summary": "Get all companionships",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
        "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
        "Client": "Sample Client 1.0.0",
        "EnterpriseIds": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "4d0201db-36f5-428b-8d11-4f0a65e960cc"
        ],
        "CompanionshipIds": [
          "72d4b117-1f84-44a3-1f84-8b2c0635ac60"
        ],
        "CustomerIds": [
          "35d4b117-4e60-44a3-9580-c582117eff98"
        ],
        "ReservationIds": [
          "bfee2c44-1f84-4326-a862-5289598f6e2d"
        ],
        "ReservationGroupIds": [
          "c704dff3-7811-4af7-a3a0-7b2b0635ac59"
        ],
        "UpdatedUtc": {
          "StartUtc": "2020-02-05T00:00:00Z",
          "EndUtc": "2020-02-10T00:00:00Z"
        },
        "Limitation": {
          "Count": 10
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Companionships": [
          {
            "Id": "72d4b117-1f84-44a3-1f84-8b2c0635ac60",
            "CustomerId": "35d4b117-4e60-44a3-9580-c582117eff98",
            "ReservationGroupId": "c704dff3-7811-4af7-a3a0-7b2b0635ac59",
            "ReservationId": "bfee2c44-1f84-4326-a862-5289598f6e2d"
          }
        ],
        "Customers": null,
        "Reservations": null,
        "ReservationGroups": null,
        "Cursor": "72d4b117-1f84-44a3-1f84-8b2c0635ac60"
      }
    }
  ]
}