v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB

Events

Gets an event entity by its unique identifier

Only Head Office defined events can be returned.

Licenses Required

Vista.Ocapi

get/ocapi/v1/events/{eventId}

Path parameters

eventIdstring required

The unique identifier of the event

Headers

Connect-Region-Codestring

Region Code

Response

Success

Example response

{
  "event": {
    "name": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    },
    "shortName": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    },
    "description": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    }
  },
  "relatedData": {
    "sites": [
      {
        "contactDetails": {
          "address": {
            "line1": "60 Khyber Pass Road",
            "line2": "Grafton",
            "city": "Auckland 1023"
          }
        },
        "ianaTimeZoneName": "America/New_York",
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ]
  }
}