Sites

Returns a detailed site and its related data based on the provided siteId.

Licenses Required

  • Vista.Ocapi
get/ocapi/v1/sites/{siteId}

Request

Path parameters

siteIdstring required

The unique identifier of site

Headers

Connect-Region-Codestring

Region Code

Response

Success

Example response

{
  "site": {
    "contactDetails": {
      "address": {
        "line1": "60 Khyber Pass Road",
        "line2": "Grafton",
        "city": "Auckland 1023"
      },
      "addressV2": {
        "line1": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "line2": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "line3": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "line4": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    },
    "ianaTimeZoneName": "America/New_York",
    "name": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    }
  }
}

Changes

    • warning

      added the new DiningLocationDelivery enum value to the /// response property for the response status

    • warning

      added the new DiningLocationDelivery enum value to the /// response property for the response status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status