Gets an event entity by its unique identifier

Only Head Office defined events can be returned.

Licenses Required

Vista.Ocapi

Request

path Parameters

eventId

required

string

The unique identifier of the event

header Parameters

Connect-Region-Code

string

Region Code

Responses

200

Success

404

Event does not exist.

get/ocapi/v1/events/{eventId}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"event": {"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortName": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"description": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"schedule": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"siteIds": ["string"
]
},
"relatedData": {"sites": [{"location": {"latitude": 0.1,
"longitude": 0.1
},
"contactDetails": {"phoneNumbers": [{"type": "Home",
"number": "string"
}
],
"email": "string",
"address": {"line1": "60 Khyber Pass Road",
"line2": "Grafton",
"city": "Auckland 1023"
}
},
"ianaTimeZoneName": "America/New_York",
"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"hasSellableItems": true,
"allowedItemDeliveryMethods": ["CounterPickup"
]
}
]
}
}