> For the complete documentation index, see [llms.txt](https://docs.hos.accessacloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/event.md). # Event Api Methods for Event ## GetEventRegisterStatus > Resolves the encoded QR key, calls the attendance helper, and returns attendance plus event/slot data. Despite its GET method and status-oriented name, the helper calls the attendance-setting stored procedure. Treat it as potentially mutating: do not prefetch, probe or retry it as an ordinary read. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"AttandanceApiOutput":{"type":"object","properties":{"Attandance":{"$ref":"#/components/schemas/EventAttandance"},"Event":{"$ref":"#/components/schemas/Event"},"ErrorCode":{"type":"integer","format":"int32","description":"The error code"},"ErrorDescription":{"type":"string","description":"The error description"}}},"EventAttandance":{"type":"object","properties":{"checkinDateTime":{"type":"string","format":"date-time","description":"The attendance date and time ."},"CtcID":{"type":"integer","format":"int32","description":"The ID of the contact ."},"Email":{"type":"string","description":"The contact email ."},"EventID":{"type":"integer","format":"int32","description":"The ID of the event ."},"FirstName":{"type":"string","description":"The contact first name"},"FullName":{"type":"string","description":"The contact fullname ."},"LastName":{"type":"string","description":"The contact last name"},"Message":{"type":"string","description":"The attendance message ."},"SlotID":{"type":"integer","format":"int32","description":"The ID of the slot ."}}},"Event":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"VenueID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Date":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"EventSpecificURL":{"type":"string","nullable":true},"EventAnonymousURL":{"type":"string","nullable":true},"Slots":{"type":"array","items":{"$ref":"#/components/schemas/_EventSlot"},"nullable":true},"EventType":{"type":"integer","format":"int32"},"BrandID":{"type":"integer","format":"int32"},"BrandName":{"type":"string","nullable":true},"Numberofinvitees":{"type":"integer","format":"int32"},"MaxAttendees":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"NumberOfRegistrations":{"type":"integer","format":"int32"},"CreatedBy":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"ApprovalStatusTemplate":{"type":"string","nullable":true},"CanApprove":{"type":"string","nullable":true},"EUID":{"type":"string","nullable":true},"HasImages":{"type":"boolean"},"EventSurveyCode":{"type":"string","nullable":true},"EventCampaignStatus":{"type":"string","nullable":true},"EventWithCampaign":{"type":"boolean"},"EventQRCodeURL":{"type":"string","nullable":true},"EventCampaignStatusTemplate":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"_EventSlot":{"type":"object","nullable":true,"properties":{"SlotID":{"type":"integer","format":"int32"},"SlotName":{"type":"string","nullable":true},"SlotStartDate":{"type":"string","format":"date-time"},"SlotEndDate":{"type":"string","format":"date-time"},"MaxDelegates":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"SlotDescription":{"type":"string","nullable":true},"SlotDetails":{"type":"string","nullable":true},"SlotApprovalStatusDescription":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/api/Event/GetEventRegisterStatus":{"get":{"operationId":"EventGetEventRegisterStatus","summary":"GetEventRegisterStatus","tags":["Event"],"description":"Resolves the encoded QR key, calls the attendance helper, and returns attendance plus event/slot data. Despite its GET method and status-oriented name, the helper calls the attendance-setting stored procedure. Treat it as potentially mutating: do not prefetch, probe or retry it as an ordinary read.","parameters":[{"name":"qrCodeGeneratedKey","in":"query","schema":{"type":"string","nullable":true},"description":"Native query parameter. CLR string qrCodeGeneratedKey in the pinned controller signature.","required":true}],"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttandanceApiOutput"}}}}}}}}} ``` ## GetEvents > Get Events list ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"EventsOutput":{"type":"object","nullable":true,"properties":{"Success":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"Error":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"Result":{"type":"string","nullable":true},"Events":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Event":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"VenueID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Date":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"EventSpecificURL":{"type":"string","nullable":true},"EventAnonymousURL":{"type":"string","nullable":true},"Slots":{"type":"array","items":{"$ref":"#/components/schemas/_EventSlot"},"nullable":true},"EventType":{"type":"integer","format":"int32"},"BrandID":{"type":"integer","format":"int32"},"BrandName":{"type":"string","nullable":true},"Numberofinvitees":{"type":"integer","format":"int32"},"MaxAttendees":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"NumberOfRegistrations":{"type":"integer","format":"int32"},"CreatedBy":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"ApprovalStatusTemplate":{"type":"string","nullable":true},"CanApprove":{"type":"string","nullable":true},"EUID":{"type":"string","nullable":true},"HasImages":{"type":"boolean"},"EventSurveyCode":{"type":"string","nullable":true},"EventCampaignStatus":{"type":"string","nullable":true},"EventWithCampaign":{"type":"boolean"},"EventQRCodeURL":{"type":"string","nullable":true},"EventCampaignStatusTemplate":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"_EventSlot":{"type":"object","nullable":true,"properties":{"SlotID":{"type":"integer","format":"int32"},"SlotName":{"type":"string","nullable":true},"SlotStartDate":{"type":"string","format":"date-time"},"SlotEndDate":{"type":"string","format":"date-time"},"MaxDelegates":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"SlotDescription":{"type":"string","nullable":true},"SlotDetails":{"type":"string","nullable":true},"SlotApprovalStatusDescription":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/api/Event/GetEvents":{"get":{"operationId":"EventGetEvents","summary":"GetEvents","tags":["Event"],"description":"Get Events list","parameters":[{"name":"Criteria","in":"query","schema":{"type":"string","nullable":true},"description":"Native query parameter. CLR string Criteria in the pinned controller signature. Omission uses the declared default.","required":false},{"name":"AvailableOnly","in":"query","schema":{"type":"boolean","default":true},"description":"Native query parameter. CLR bool AvailableOnly in the pinned controller signature. Omission uses the declared default.","required":false},{"name":"FromDate","in":"query","schema":{"type":"string","format":"date-time","nullable":true},"description":"Native query parameter. CLR DateTime? FromDate in the pinned controller signature. Omission uses the declared default.","required":false},{"name":"BrandID","in":"query","schema":{"type":"integer","format":"int32","nullable":true},"description":"Native query parameter. CLR int? BrandID in the pinned controller signature. Omission uses the declared default.","required":false},{"name":"ToDate","in":"query","schema":{"type":"string","format":"date-time","nullable":true},"description":"Native query parameter. CLR DateTime? ToDate in the pinned controller signature. Omission uses the declared default.","required":false}],"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsOutput"}}}}}}}}} ``` ## GetEventTarget > Retrieves the event target/attendance list for EventID and SlotID, together with event details. The action includes all event slots when SlotID is zero and selects the requested slot otherwise. Response property spelling, including EventTarget, is preserved from the native model. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"EventTargetApiOutput":{"type":"object","properties":{"Event":{"$ref":"#/components/schemas/Event"},"EventTarget":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EventAttandance"}},"ErrorCode":{"type":"integer","format":"int32","description":"The error code"},"ErrorDescription":{"type":"string","description":"The error description"}}},"Event":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"VenueID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Date":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"EventSpecificURL":{"type":"string","nullable":true},"EventAnonymousURL":{"type":"string","nullable":true},"Slots":{"type":"array","items":{"$ref":"#/components/schemas/_EventSlot"},"nullable":true},"EventType":{"type":"integer","format":"int32"},"BrandID":{"type":"integer","format":"int32"},"BrandName":{"type":"string","nullable":true},"Numberofinvitees":{"type":"integer","format":"int32"},"MaxAttendees":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"NumberOfRegistrations":{"type":"integer","format":"int32"},"CreatedBy":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"ApprovalStatusTemplate":{"type":"string","nullable":true},"CanApprove":{"type":"string","nullable":true},"EUID":{"type":"string","nullable":true},"HasImages":{"type":"boolean"},"EventSurveyCode":{"type":"string","nullable":true},"EventCampaignStatus":{"type":"string","nullable":true},"EventWithCampaign":{"type":"boolean"},"EventQRCodeURL":{"type":"string","nullable":true},"EventCampaignStatusTemplate":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"_EventSlot":{"type":"object","nullable":true,"properties":{"SlotID":{"type":"integer","format":"int32"},"SlotName":{"type":"string","nullable":true},"SlotStartDate":{"type":"string","format":"date-time"},"SlotEndDate":{"type":"string","format":"date-time"},"MaxDelegates":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"SlotDescription":{"type":"string","nullable":true},"SlotDetails":{"type":"string","nullable":true},"SlotApprovalStatusDescription":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"EventAttandance":{"type":"object","properties":{"checkinDateTime":{"type":"string","format":"date-time","description":"The attendance date and time ."},"CtcID":{"type":"integer","format":"int32","description":"The ID of the contact ."},"Email":{"type":"string","description":"The contact email ."},"EventID":{"type":"integer","format":"int32","description":"The ID of the event ."},"FirstName":{"type":"string","description":"The contact first name"},"FullName":{"type":"string","description":"The contact fullname ."},"LastName":{"type":"string","description":"The contact last name"},"Message":{"type":"string","description":"The attendance message ."},"SlotID":{"type":"integer","format":"int32","description":"The ID of the slot ."}}}}},"paths":{"/api/Event/GetEventTarget":{"get":{"operationId":"EventGetEventTarget","summary":"GetEventTarget","tags":["Event"],"description":"Retrieves the event target/attendance list for EventID and SlotID, together with event details. The action includes all event slots when SlotID is zero and selects the requested slot otherwise. Response property spelling, including EventTarget, is preserved from the native model.","parameters":[{"name":"EventID","in":"query","schema":{"type":"integer","format":"int32"},"description":"Native query parameter. CLR int EventID in the pinned controller signature.","required":true},{"name":"SlotID","in":"query","schema":{"type":"integer","format":"int32"},"description":"Native query parameter. CLR int SlotID in the pinned controller signature.","required":true}],"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTargetApiOutput"}}}}}}}}} ``` ## GetEventTypes > Retrieves event-type records through the event-type lookup using EventTypeID and returns EventTypesOutPut. The payload is the EventTypes list beside Response and Error. Valid identifiers and database filtering semantics are instance-dependent; a missing parameter is not automatically equivalent to requesting all types. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"EventTypesOutPut":{"type":"object","nullable":true,"properties":{"Error":{"type":"string","nullable":true},"Response":{"type":"boolean"},"EventTypes":{"type":"array","items":{"$ref":"#/components/schemas/EventTypeInput"},"nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"EventTypeInput":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Delete":{"type":"boolean"}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/api/Event/GetEventTypes":{"get":{"operationId":"EventGetEventTypes","summary":"GetEventTypes","tags":["Event"],"description":"Retrieves event-type records through the event-type lookup using EventTypeID and returns EventTypesOutPut. The payload is the EventTypes list beside Response and Error. Valid identifiers and database filtering semantics are instance-dependent; a missing parameter is not automatically equivalent to requesting all types.","parameters":[{"name":"EventTypeID","in":"query","schema":{"type":"integer","format":"int32","nullable":true},"description":"Native query parameter. CLR int? EventTypeID in the pinned controller signature.","required":true}],"responses":{"200":{"description":"Source return path at pinned commit; runtime and deployed-version alignment unverified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTypesOutPut"}}}}}}}}} ``` ## GetEventVenue > Retrieves venue details for VenueID through the event helper. The result uses VenuesOutPut with the Venue payload, Response flag and Error string. Confirm valid venue identifiers in the approved instance; this lookup does not establish that a venue is bookable or available for an event. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"VenuesOutPut":{"type":"object","nullable":true,"properties":{"Error":{"type":"string","nullable":true},"Response":{"type":"boolean"},"Venue":{"allOf":[{"$ref":"#/components/schemas/Venue"}]}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Venue":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Street":{"type":"string","nullable":true},"Building":{"type":"string","nullable":true},"buildingzone":{"type":"string","nullable":true},"FullAddress":{"type":"string","nullable":true},"Postcode":{"type":"string","nullable":true},"URL":{"type":"string","nullable":true},"City":{"type":"string","nullable":true},"ImageName":{"type":"string","nullable":true},"Image":{"type":"string","nullable":true},"Deleted":{"type":"boolean"},"EventTypes":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"EventType":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"EventypeID":{"type":"array","items":{"type":"string","nullable":true},"nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/api/Event/GetEventVenue":{"get":{"operationId":"EventGetEventVenue","summary":"GetEventVenue","tags":["Event"],"description":"Retrieves venue details for VenueID through the event helper. The result uses VenuesOutPut with the Venue payload, Response flag and Error string. Confirm valid venue identifiers in the approved instance; this lookup does not establish that a venue is bookable or available for an event.","parameters":[{"name":"VenueID","in":"query","schema":{"type":"integer","format":"int32"},"description":"Native query parameter. CLR int VenueID in the pinned controller signature.","required":true}],"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenuesOutPut"}}}}}}}}} ``` ## ManageEventType > Checks whether the supplied event-type Description exists and calls the event-type creation helper when appropriate. Inspect Success and Error in EventsOutput. Do not infer that every input property implements deletion or editing: the verified controller path is the description/existence/add path. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"EventTypeInput":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Delete":{"type":"boolean"}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"EventsOutput":{"type":"object","nullable":true,"properties":{"Success":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"Error":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"Result":{"type":"string","nullable":true},"Events":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Event":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"VenueID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Date":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"EventSpecificURL":{"type":"string","nullable":true},"EventAnonymousURL":{"type":"string","nullable":true},"Slots":{"type":"array","items":{"$ref":"#/components/schemas/_EventSlot"},"nullable":true},"EventType":{"type":"integer","format":"int32"},"BrandID":{"type":"integer","format":"int32"},"BrandName":{"type":"string","nullable":true},"Numberofinvitees":{"type":"integer","format":"int32"},"MaxAttendees":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"NumberOfRegistrations":{"type":"integer","format":"int32"},"CreatedBy":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"ApprovalStatusTemplate":{"type":"string","nullable":true},"CanApprove":{"type":"string","nullable":true},"EUID":{"type":"string","nullable":true},"HasImages":{"type":"boolean"},"EventSurveyCode":{"type":"string","nullable":true},"EventCampaignStatus":{"type":"string","nullable":true},"EventWithCampaign":{"type":"boolean"},"EventQRCodeURL":{"type":"string","nullable":true},"EventCampaignStatusTemplate":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"_EventSlot":{"type":"object","nullable":true,"properties":{"SlotID":{"type":"integer","format":"int32"},"SlotName":{"type":"string","nullable":true},"SlotStartDate":{"type":"string","format":"date-time"},"SlotEndDate":{"type":"string","format":"date-time"},"MaxDelegates":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"SlotDescription":{"type":"string","nullable":true},"SlotDetails":{"type":"string","nullable":true},"SlotApprovalStatusDescription":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/api/Event/ManageEventType":{"post":{"operationId":"EventManageEventType","summary":"ManageEventType","tags":["Event"],"description":"Checks whether the supplied event-type Description exists and calls the event-type creation helper when appropriate. Inspect Success and Error in EventsOutput. Do not infer that every input property implements deletion or editing: the verified controller path is the description/existence/add path.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTypeInput"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsOutput"}}}}}}}}} ``` ## ManageSlot > Maps the supplied slot details into the event-slot model and calls the add or update helper according to SlotID. Returns EventsOutput with the helper result and business status. The controller-bound input includes SlotDescription, SlotDetails and Picture; it is not the same-named model containing Agenda elsewhere. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"ManageSlotInput":{"type":"object","nullable":false,"properties":{"SlotID":{"type":"integer","format":"int32"},"EventID":{"type":"integer","format":"int32","nullable":false},"Name":{"type":"string","nullable":false,"minLength":1},"StartDate":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"MaxVisitor":{"type":"integer","format":"int32"},"WaitList":{"type":"integer","format":"int32"},"SlotDescription":{"type":"string","nullable":true},"SlotDetails":{"type":"string","nullable":true},"Picture":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified.","required":["EventID","Name"]},"EventsOutput":{"type":"object","nullable":true,"properties":{"Success":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"Error":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"Result":{"type":"string","nullable":true},"Events":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Event":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"VenueID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Date":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"EventSpecificURL":{"type":"string","nullable":true},"EventAnonymousURL":{"type":"string","nullable":true},"Slots":{"type":"array","items":{"$ref":"#/components/schemas/_EventSlot"},"nullable":true},"EventType":{"type":"integer","format":"int32"},"BrandID":{"type":"integer","format":"int32"},"BrandName":{"type":"string","nullable":true},"Numberofinvitees":{"type":"integer","format":"int32"},"MaxAttendees":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"NumberOfRegistrations":{"type":"integer","format":"int32"},"CreatedBy":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"ApprovalStatusTemplate":{"type":"string","nullable":true},"CanApprove":{"type":"string","nullable":true},"EUID":{"type":"string","nullable":true},"HasImages":{"type":"boolean"},"EventSurveyCode":{"type":"string","nullable":true},"EventCampaignStatus":{"type":"string","nullable":true},"EventWithCampaign":{"type":"boolean"},"EventQRCodeURL":{"type":"string","nullable":true},"EventCampaignStatusTemplate":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"_EventSlot":{"type":"object","nullable":true,"properties":{"SlotID":{"type":"integer","format":"int32"},"SlotName":{"type":"string","nullable":true},"SlotStartDate":{"type":"string","format":"date-time"},"SlotEndDate":{"type":"string","format":"date-time"},"MaxDelegates":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"SlotDescription":{"type":"string","nullable":true},"SlotDetails":{"type":"string","nullable":true},"SlotApprovalStatusDescription":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/api/Event/ManageSlot":{"post":{"operationId":"EventManageSlot","summary":"ManageSlot","tags":["Event"],"description":"Maps the supplied slot details into the event-slot model and calls the add or update helper according to SlotID. Returns EventsOutput with the helper result and business status. The controller-bound input includes SlotDescription, SlotDetails and Picture; it is not the same-named model containing Agenda elsewhere.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageSlotInput"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsOutput"}}}}}}}}} ``` ## ManageVenue > Adds a venue when ID is zero or calls the venue-update helper for an existing ID, passing the supplied venue and event-type details. This writes venue data and returns EventsOutput. Inspect Success and Error; it is not a venue-availability or booking operation. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"Venue":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Street":{"type":"string","nullable":true},"Building":{"type":"string","nullable":true},"buildingzone":{"type":"string","nullable":true},"FullAddress":{"type":"string","nullable":true},"Postcode":{"type":"string","nullable":true},"URL":{"type":"string","nullable":true},"City":{"type":"string","nullable":true},"ImageName":{"type":"string","nullable":true},"Image":{"type":"string","nullable":true},"Deleted":{"type":"boolean"},"EventTypes":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"EventType":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"EventypeID":{"type":"array","items":{"type":"string","nullable":true},"nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"EventsOutput":{"type":"object","nullable":true,"properties":{"Success":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"Error":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"Result":{"type":"string","nullable":true},"Events":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Event":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"VenueID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Date":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"EventSpecificURL":{"type":"string","nullable":true},"EventAnonymousURL":{"type":"string","nullable":true},"Slots":{"type":"array","items":{"$ref":"#/components/schemas/_EventSlot"},"nullable":true},"EventType":{"type":"integer","format":"int32"},"BrandID":{"type":"integer","format":"int32"},"BrandName":{"type":"string","nullable":true},"Numberofinvitees":{"type":"integer","format":"int32"},"MaxAttendees":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"NumberOfRegistrations":{"type":"integer","format":"int32"},"CreatedBy":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"ApprovalStatusTemplate":{"type":"string","nullable":true},"CanApprove":{"type":"string","nullable":true},"EUID":{"type":"string","nullable":true},"HasImages":{"type":"boolean"},"EventSurveyCode":{"type":"string","nullable":true},"EventCampaignStatus":{"type":"string","nullable":true},"EventWithCampaign":{"type":"boolean"},"EventQRCodeURL":{"type":"string","nullable":true},"EventCampaignStatusTemplate":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"_EventSlot":{"type":"object","nullable":true,"properties":{"SlotID":{"type":"integer","format":"int32"},"SlotName":{"type":"string","nullable":true},"SlotStartDate":{"type":"string","format":"date-time"},"SlotEndDate":{"type":"string","format":"date-time"},"MaxDelegates":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"SlotDescription":{"type":"string","nullable":true},"SlotDetails":{"type":"string","nullable":true},"SlotApprovalStatusDescription":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/api/Event/ManageVenue":{"post":{"operationId":"EventManageVenue","summary":"ManageVenue","tags":["Event"],"description":"Adds a venue when ID is zero or calls the venue-update helper for an existing ID, passing the supplied venue and event-type details. This writes venue data and returns EventsOutput. Inspect Success and Error; it is not a venue-availability or booking operation.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Venue"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsOutput"}}}}}}}}} ``` ## PostEvent > Validates supplied event details and calls the add/update event helper, including the audience-node input. UserID is set from the authenticated caller in the action. Returns EventsOutput with Success, Error and helper result fields. This is an event mutation; approval, dates and valid venue/type identifiers remain subject to the instance and downstream helper behaviour. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"EventApi":{"type":"object","nullable":false,"properties":{"ID":{"type":"integer","format":"int32"},"External_ID":{"type":"string","nullable":true},"UserID":{"type":"integer","format":"int32"},"ProgrammeID":{"type":"integer","format":"int32"},"CampaignID":{"type":"integer","format":"int32"},"VenueID":{"type":"integer","format":"int32","nullable":false},"Region":{"type":"integer","format":"int32"},"EventOwner":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":false,"minLength":1},"Description":{"type":"string","nullable":true},"EventContactName":{"type":"string","nullable":false,"minLength":1},"EventContactPhoneNumber":{"type":"string","nullable":true},"EventContactEmailAddress":{"type":"string","nullable":false,"minLength":1},"EventContactAddress":{"type":"string","nullable":true},"EventUrl":{"type":"string","nullable":true},"Nameforlink":{"type":"string","nullable":true},"EventImage":{"type":"string","nullable":true},"EventTeaser":{"type":"string","nullable":true},"EventType":{"type":"integer","format":"int32","nullable":false},"Approved":{"type":"integer","format":"int32"},"Deleted":{"type":"boolean"},"AdditionalInformation":{"type":"string","nullable":true},"WhereToMeet":{"type":"string","nullable":true},"WhatToBring":{"type":"string","nullable":true},"EventStartDate":{"type":"string","format":"date-time"},"EventEndDate":{"type":"string","format":"date-time"},"LastRegistrationDate":{"type":"string","format":"date-time","nullable":true},"EventSpecificURL":{"type":"string","nullable":true},"EventAnonymousURL":{"type":"string","nullable":true},"EventQRCodeURL":{"type":"string","nullable":true},"MaxDelegates":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"Numberofinvitees":{"type":"integer","format":"int32"},"MaxAttendees":{"type":"integer","format":"int32"},"NumberOfRegistrations":{"type":"integer","format":"int32"},"CreatedBy":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"VenueName":{"type":"string","nullable":true},"CanApprove":{"type":"string","nullable":true},"ApprovalStatusTemplate":{"type":"string","nullable":true},"UserFinalApproval":{"type":"boolean"},"OnlyOneRegistration":{"type":"boolean"},"RegistrationReminder":{"type":"boolean","nullable":true},"EventSurveyCode":{"type":"string","nullable":true},"Slots":{"type":"array","items":{"$ref":"#/components/schemas/_EventSlot"},"nullable":true},"EventCampaignStatus":{"type":"string","nullable":true},"EventWithCampaign":{"type":"boolean"},"BrandID":{"type":"integer","format":"int32"},"BrandName":{"type":"string","nullable":true},"PushNotificationImage":{"type":"string","nullable":true},"Facebook":{"type":"string","nullable":true},"Instagram":{"type":"string","nullable":true},"Twitter":{"type":"string","nullable":true},"EventCampaignStatusTemplate":{"type":"string","nullable":true},"_AudiencesNodes":{"type":"array","items":{"$ref":"#/components/schemas/Node"},"nullable":true},"ReferFriend":{"type":"boolean"},"AdressDetails":{"type":"boolean"},"QRCode":{"type":"boolean"},"ZoomWebinarID":{"type":"string","nullable":true},"ZoomWebinarLink":{"type":"string","nullable":true},"ZoomRecording":{"type":"string","nullable":true},"IsVirtualEvent":{"type":"boolean","nullable":true},"PrivacyPolicyText":{"type":"string","nullable":true},"PrivacyPolicyLink":{"type":"string","nullable":true},"PrivacyPolicyTextArea":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified.","required":["Name","VenueID","EventType","EventContactName","EventContactEmailAddress"]},"_EventSlot":{"type":"object","nullable":true,"properties":{"SlotID":{"type":"integer","format":"int32"},"SlotName":{"type":"string","nullable":true},"SlotStartDate":{"type":"string","format":"date-time"},"SlotEndDate":{"type":"string","format":"date-time"},"MaxDelegates":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"SlotDescription":{"type":"string","nullable":true},"SlotDetails":{"type":"string","nullable":true},"SlotApprovalStatusDescription":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Node":{"type":"object","nullable":true,"properties":{"k__BackingField":{"type":"boolean"},"k__BackingField":{"type":"boolean"},"k__BackingField":{"type":"boolean"},"k__BackingField":{"type":"boolean"},"k__BackingField":{"type":"string","nullable":true},"k__BackingField":{"type":"string","nullable":true},"k__BackingField":{"type":"string","nullable":true},"k__BackingField":{"type":"boolean"},"Autogenerated":{"type":"boolean"},"k__BackingField":{"type":"boolean"},"k__BackingField":{"type":"boolean"},"k__BackingField":{"type":"boolean"},"k__BackingField":{"type":"boolean"},"k__BackingField":{"type":"boolean"},"k__BackingField":{"type":"string","nullable":true},"k__BackingField":{"type":"array","items":{"type":"object","nullable":true,"additionalProperties":true,"description":"APIM import-only relaxation of the recursive Node child reference. Child object structure is open because APIM does not support recursive schema definitions. The full recursive contract is preserved in reference/openapi.yaml. No maximum recursion depth, payload transformation or runtime compatibility is implied."},"nullable":true},"k__BackingField":{"allOf":[{"$ref":"#/components/schemas/WizardSegmentation"}]}},"allOf":[{"$ref":"#/components/schemas/BasicNode"}],"description":"Serializable CLR class: Web API 5.2.7 JsonContractResolver sets IgnoreSerializableAttribute=false. The JSON contract uses instance fields, including compiler-generated backing fields, rather than ordinary CLR property names. Computed properties without backing fields are not included. Runtime-unverified."},"WizardSegmentation":{"type":"object","nullable":true,"properties":{"k__BackingField":{"type":"array","items":{"$ref":"#/components/schemas/Group"},"nullable":true},"k__BackingField":{"type":"array","items":{"$ref":"#/components/schemas/Exclude"},"nullable":true},"k__BackingField":{"type":"string","nullable":true},"<description>k__BackingField":{"type":"string","nullable":true},"<querySummary>k__BackingField":{"type":"string","nullable":true},"<globalOperator>k__BackingField":{"type":"string","nullable":true},"<excludeOperator>k__BackingField":{"type":"string","nullable":true},"<excludeQuery>k__BackingField":{"type":"string","nullable":true},"<excludeQuerySummary>k__BackingField":{"type":"string","nullable":true},"<globalCount>k__BackingField":{"type":"integer","format":"int32"},"selectionID":{"type":"integer","format":"int32"},"<excludeNodeId>k__BackingField":{"type":"string","nullable":true},"<excludeNodeCode>k__BackingField":{"type":"integer","format":"int32"}},"description":"Serializable CLR class: Web API 5.2.7 JsonContractResolver sets IgnoreSerializableAttribute=false. The JSON contract uses instance fields, including compiler-generated backing fields, rather than ordinary CLR property names. Computed properties without backing fields are not included. Runtime-unverified."},"Group":{"type":"object","nullable":true,"properties":{"<id>k__BackingField":{"type":"integer","format":"int64"},"<criteria>k__BackingField":{"type":"array","items":{"$ref":"#/components/schemas/Criteria"},"nullable":true},"<cnt_interaction>k__BackingField":{"allOf":[{"$ref":"#/components/schemas/CntInterraction"}]},"<querySummary>k__BackingField":{"type":"string","nullable":true},"<query>k__BackingField":{"type":"string","nullable":true},"<criteria_operator>k__BackingField":{"type":"string","nullable":true},"<NodeCode>k__BackingField":{"type":"integer","format":"int32"},"<NodeId>k__BackingField":{"type":"string","nullable":true}},"description":"Serializable CLR class: Web API 5.2.7 JsonContractResolver sets IgnoreSerializableAttribute=false. The JSON contract uses instance fields, including compiler-generated backing fields, rather than ordinary CLR property names. Computed properties without backing fields are not included. Runtime-unverified."},"Criteria":{"type":"object","nullable":true,"properties":{"<index>k__BackingField":{"type":"integer","format":"int64"},"<nodeCode>k__BackingField":{"type":"integer","format":"int64"},"<nodeText>k__BackingField":{"type":"string","nullable":true},"<nodeAtrribute>k__BackingField":{"type":"string","nullable":true},"<filter>k__BackingField":{"type":"string","nullable":true},"<filterText>k__BackingField":{"type":"string","nullable":true},"<value>k__BackingField":{"type":"string","nullable":true},"<queryCtc>k__BackingField":{"type":"string","nullable":true},"<queryStringClause>k__BackingField":{"type":"string","nullable":true}},"description":"Serializable CLR class: Web API 5.2.7 JsonContractResolver sets IgnoreSerializableAttribute=false. The JSON contract uses instance fields, including compiler-generated backing fields, rather than ordinary CLR property names. Computed properties without backing fields are not included. Runtime-unverified."},"CntInterraction":{"type":"object","nullable":true,"properties":{"<filter>k__BackingField":{"type":"string","nullable":true},"<filterText>k__BackingField":{"type":"string","nullable":true},"<value>k__BackingField":{"type":"integer","format":"int64"}},"description":"Serializable CLR class: Web API 5.2.7 JsonContractResolver sets IgnoreSerializableAttribute=false. The JSON contract uses instance fields, including compiler-generated backing fields, rather than ordinary CLR property names. Computed properties without backing fields are not included. Runtime-unverified."},"Exclude":{"type":"object","nullable":true,"properties":{},"allOf":[{"$ref":"#/components/schemas/Criteria"}],"description":"Serializable CLR class: Web API 5.2.7 JsonContractResolver sets IgnoreSerializableAttribute=false. The JSON contract uses instance fields, including compiler-generated backing fields, rather than ordinary CLR property names. Computed properties without backing fields are not included. Runtime-unverified."},"BasicNode":{"type":"object","nullable":true,"properties":{"<CritSql>k__BackingField":{"type":"string","nullable":true},"<NodeCode>k__BackingField":{"type":"integer","format":"int32"},"<ParentNodeCode>k__BackingField":{"type":"integer","format":"int32"},"<CritType>k__BackingField":{"type":"integer","format":"int32"},"<CritSqlType>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<Value>k__BackingField":{"type":"integer","format":"int32"},"<Text>k__BackingField":{"type":"string","nullable":true},"<ToolTip>k__BackingField":{"type":"string","nullable":true},"<Category>k__BackingField":{"type":"string","nullable":true},"<MinusPosition>k__BackingField":{"type":"string"},"<parentTempIdStats>k__BackingField":{"type":"string","nullable":true},"<RuleValue>k__BackingField":{"type":"string","nullable":true},"<RuleOperator>k__BackingField":{"type":"string","nullable":true},"<NodeType>k__BackingField":{"type":"string","nullable":true},"<BrandID>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<IconImage>k__BackingField":{"type":"string","nullable":true},"<IsFromLibrary>k__BackingField":{"type":"boolean"},"<IconID>k__BackingField":{"type":"integer","format":"int32"},"<IsHiddenInAPI>k__BackingField":{"type":"boolean"},"<IsOther>k__BackingField":{"type":"boolean"},"<AttributeFullPath>k__BackingField":{"type":"string","nullable":true},"<ParentNodeType>k__BackingField":{"type":"string","nullable":true},"<IsChecked>k__BackingField":{"type":"boolean"},"<CustomWizardNodeHtml>k__BackingField":{"type":"string","nullable":true},"<reverseEngValue>k__BackingField":{"type":"integer","format":"int32"},"<CustomQuery>k__BackingField":{"allOf":[{"$ref":"#/components/schemas/CustomQuery"}]},"_id":{"type":"string","nullable":true}},"description":"Serializable CLR class: Web API 5.2.7 JsonContractResolver sets IgnoreSerializableAttribute=false. The JSON contract uses instance fields, including compiler-generated backing fields, rather than ordinary CLR property names. Computed properties without backing fields are not included. Runtime-unverified."},"CustomQuery":{"type":"object","nullable":true,"properties":{"<operator>k__BackingField":{"type":"string","nullable":true},"<queries>k__BackingField":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true},"nullable":true}},"description":"Serializable CLR class: Web API 5.2.7 JsonContractResolver sets IgnoreSerializableAttribute=false. The JSON contract uses instance fields, including compiler-generated backing fields, rather than ordinary CLR property names. Computed properties without backing fields are not included. Runtime-unverified."},"EventsOutput":{"type":"object","nullable":true,"properties":{"Success":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"Error":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"Result":{"type":"string","nullable":true},"Events":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Event":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"VenueID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Date":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"EventSpecificURL":{"type":"string","nullable":true},"EventAnonymousURL":{"type":"string","nullable":true},"Slots":{"type":"array","items":{"$ref":"#/components/schemas/_EventSlot"},"nullable":true},"EventType":{"type":"integer","format":"int32"},"BrandID":{"type":"integer","format":"int32"},"BrandName":{"type":"string","nullable":true},"Numberofinvitees":{"type":"integer","format":"int32"},"MaxAttendees":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"NumberOfRegistrations":{"type":"integer","format":"int32"},"CreatedBy":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"ApprovalStatusTemplate":{"type":"string","nullable":true},"CanApprove":{"type":"string","nullable":true},"EUID":{"type":"string","nullable":true},"HasImages":{"type":"boolean"},"EventSurveyCode":{"type":"string","nullable":true},"EventCampaignStatus":{"type":"string","nullable":true},"EventWithCampaign":{"type":"boolean"},"EventQRCodeURL":{"type":"string","nullable":true},"EventCampaignStatusTemplate":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/api/Event/PostEvent":{"post":{"operationId":"EventPostEvent","summary":"PostEvent","tags":["Event"],"description":"Validates supplied event details and calls the add/update event helper, including the audience-node input. UserID is set from the authenticated caller in the action. Returns EventsOutput with Success, Error and helper result fields. This is an event mutation; approval, dates and valid venue/type identifiers remain subject to the instance and downstream helper behaviour.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventApi"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsOutput"}}}}}}}}} ``` ## RegisterToEvent > Updates a customer's registration status for an event slot. The action checks nonzero CtcID, EventID and SlotID and passes nullable Registered to CustomerUpdateRegistrationSlotStatus. It returns EventsOutput; the declared Attended member is not passed to that helper by this action. The helper sends a true Registered bit only for the value 1, and false for other values including null. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer <token>`. See the Authorisation guide."}},"schemas":{"RegisterEventInput":{"type":"object","nullable":true,"properties":{"CtcID":{"type":"integer","format":"int32"},"EventID":{"type":"integer","format":"int32"},"SlotID":{"type":"integer","format":"int32"},"Registered":{"type":"integer","format":"int32","nullable":true,"description":"Nullable registration input. Helpers/EventsHelper.cs:5012-5037 sends a true Registered bit when this equals 1; every other value, including null, sends false. This is not a closed integer enum."},"Attended":{"type":"boolean"}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"EventsOutput":{"type":"object","nullable":true,"properties":{"Success":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"Error":{"type":"array","items":{"type":"string","nullable":true},"nullable":true},"Result":{"type":"string","nullable":true},"Events":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Event":{"type":"object","nullable":true,"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"VenueID":{"type":"integer","format":"int32"},"Description":{"type":"string","nullable":true},"Date":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"EventSpecificURL":{"type":"string","nullable":true},"EventAnonymousURL":{"type":"string","nullable":true},"Slots":{"type":"array","items":{"$ref":"#/components/schemas/_EventSlot"},"nullable":true},"EventType":{"type":"integer","format":"int32"},"BrandID":{"type":"integer","format":"int32"},"BrandName":{"type":"string","nullable":true},"Numberofinvitees":{"type":"integer","format":"int32"},"MaxAttendees":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"NumberOfRegistrations":{"type":"integer","format":"int32"},"CreatedBy":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"ApprovalStatusTemplate":{"type":"string","nullable":true},"CanApprove":{"type":"string","nullable":true},"EUID":{"type":"string","nullable":true},"HasImages":{"type":"boolean"},"EventSurveyCode":{"type":"string","nullable":true},"EventCampaignStatus":{"type":"string","nullable":true},"EventWithCampaign":{"type":"boolean"},"EventQRCodeURL":{"type":"string","nullable":true},"EventCampaignStatusTemplate":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"_EventSlot":{"type":"object","nullable":true,"properties":{"SlotID":{"type":"integer","format":"int32"},"SlotName":{"type":"string","nullable":true},"SlotStartDate":{"type":"string","format":"date-time"},"SlotEndDate":{"type":"string","format":"date-time"},"MaxDelegates":{"type":"integer","format":"int32"},"WaitingList":{"type":"integer","format":"int32"},"SlotDescription":{"type":"string","nullable":true},"SlotDetails":{"type":"string","nullable":true},"SlotApprovalStatusDescription":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/api/Event/RegisterToEvent":{"post":{"operationId":"EventRegisterToEvent","summary":"RegisterToEvent","tags":["Event"],"description":"Updates a customer's registration status for an event slot. The action checks nonzero CtcID, EventID and SlotID and passes nullable Registered to CustomerUpdateRegistrationSlotStatus. It returns EventsOutput; the declared Attended member is not passed to that helper by this action. The helper sends a true Registered bit only for the value 1, and false for other values including null.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterEventInput"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsOutput"}}}}}}}}} ``` ## ScanQrCode > Scan QrCode ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Event","description":"Api Methods for Event"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer <token>`. See the Authorisation guide."}},"schemas":{"EventattendanceOutput":{"type":"object","properties":{"attendanceOutput":{"allOf":[{"$ref":"#/components/schemas/EventAttandance"}],"description":"return the attendance output."},"Error":{"type":"array","items":{"type":"string"},"description":"return list of errors if exist."},"Success":{"type":"boolean","description":"boolean to return the call success status ."}}},"EventAttandance":{"type":"object","properties":{"checkinDateTime":{"type":"string","format":"date-time","description":"The attendance date and time ."},"CtcID":{"type":"integer","format":"int32","description":"The ID of the contact ."},"Email":{"type":"string","description":"The contact email ."},"EventID":{"type":"integer","format":"int32","description":"The ID of the event ."},"FirstName":{"type":"string","description":"The contact first name"},"FullName":{"type":"string","description":"The contact fullname ."},"LastName":{"type":"string","description":"The contact last name"},"Message":{"type":"string","description":"The attendance message ."},"SlotID":{"type":"integer","format":"int32","description":"The ID of the slot ."}}}}},"paths":{"/api/Event/ScanQrCode":{"get":{"operationId":"EventScanQrCode","summary":"ScanQrCode","tags":["Event"],"description":"Scan QrCode","parameters":[{"name":"input","in":"query","schema":{"type":"string","nullable":true},"description":"Native query parameter. CLR string input in the pinned controller signature.","required":true}],"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventattendanceOutput"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/event.md?ask=<question>&goal=<user_goal> ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.