Portal Events

The Portal Events API allows the user to access inventory lists for events. It pulls and shares data with our other cloud services such as Data Management and the Portal.

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Endpoints

GET /{companyid}/events

Summary

Get the list of events for a specific company.

Request Parameters

In	Field Name	Type	Required	Description
path	`companyid`	string	Yes	The identifier (ID) of the company
query	`$skip`	number	No	The documents to skip before returning
query	`$top`	number	No	The maximum documents to return
query	`$filter`	string	No	A filter expression in OData v4 format
query	`$orderby`	string	No	An order by expression in OData v4 format
query	`$select`	string	No	Select expression in OData v4 format (Cannot work on `available_sites` field)
query	`include_available_sites`	boolean	No	Is there need to get actual event related sites
query	`available_sites_select`	string	No	A path array string (split with ',') in the lodash pick expression

Response

Code	Description	Schema
200	Success	events_document
400	Bad request, for more information look at body error
401	Invalid token
403	Forbidden error
500	Internal Server Error

GET /{companyid}/events/{event_id}

Summary

Get the detail information of an event for a specific company.

Request Parameters

In	Field Name	Type	Required	Description
path	`companyid`	string	Yes	The identifier (ID) of the company
path	`event_id`	string	Yes	The ID of the event

Response

Code	Description	Schema
200	Success	event_document
400	Bad request, for more information look at body error
401	Invalid token
403	Forbidden error
404	Not Found
500	Internal Server Error

POST /{companyid}/events

Summary

Create the event.

Request Parameters

In	Field Name	Type	Required	Description
path	`companyid`	string	Yes	The identifier (ID) of the company
body	`body`	event_external_create	Yes	The JSON formatted request

Response

Code	Description	Schema
201	Success	event_document
400	Bad request, for more information look at body error
401	Invalid token
403	Forbidden error
500	Internal Server Error

PUT /{companyid}/events/{event_id}

Summary

Update the event by the event_id.

Request Parameters

In	Field Name	Type	Required	Description
path	`companyid`	string	Yes	The identifier (ID) of the company
path	`event_id`	string	Yes	The ID of the event
body	`body`	event_external_update	Yes	The JSON formatted request

Response

Code	Description	Schema
200	Success	event_document
400	Bad request, for more information look at body error
401	Invalid token
403	Forbidden error
404	Not Found
500	Internal Server Error

DELETE /{companyid}/events/{event_id}

Summary

Delete the event by the event_id.

Request Parameters

In	Field Name	Type	Required	Description
path	`companyid`	string	Yes	The identifier (ID) of the company
path	`event_id`	string	Yes	The ID of the event

Response

Code	Description	Schema
204	Success
400	Bad request, for more information look at body error
401	Invalid token
403	Forbidden error
404	Not Found
500	Internal Server Error

Data Models

events_document

Field Name	Type	Description
`items`	[event_document]
`total`	number	The total number of events with the current filter

event_external_create

Field Name	Type	Required	Description
`name`	string	Yes	The event name
`description`	string	No	The event description
`status`	string	Yes	The event status
`is_multi_day`	boolean	Yes	If false, it means that the event will exist within one day
`event_type_entity_id`	string	Yes	The `entity_id` of this event type
`availability_conditions`	availability_conditions	No	The availability data for the event. The default is `all` sites.
`suite_spot_visible`	boolean	No	If false, it means that the event will not display in the suite spot
`event_days`	[event_day]	Yes
`advanced_day_ordering`	advanced_day_ordering	No	Advanced Day Ordering (ADO)
`event_day_ordering`	event_day	No	Event Day Ordering (EDO)
`images`	string	No

event_external_update

Field Name	Type	Required	Description
`name`	string	No	The event name
`description`	string	No	The event description
`status`	string	No	The event status
`is_multi_day`	boolean	No	If false, it means that the event will exist within one day
`event_type_entity_id`	string	No	The `entity_id` of this event type
`availability_conditions`	availability_conditions	No	The availability data for the event. The default is `all` sites.
`suite_spot_visible`	boolean	No	If false, it means that the event will not display in suite spot
`event_days`	[event_day]	Yes
`advanced_day_ordering`	advanced_day_ordering	No	Advanced Day Ordering (ADO)
`event_day_ordering`	event_day	No	Event Day Ordering (EDO)
`images`	string	Yes

event_document

Field Name	Type	Required	Description
`active`	boolean	No	The marking property is the essence of active documents. Sets in `true` by default
`is_active`	boolean	Yes	The marking property is the essence of active documents. Sets in `true` by default
`company_id`	string	No	The identifier (ID) of the company who owns the document
`name`	string	Yes	The event name
`description`	string	No	The event description
`status`	string	Yes	The event status
`is_multi_day`	boolean	Yes	If false, it means that the event will exist within one day
`event_type_entity_id`	string	Yes	The `entity_id` of this event type
`availability_conditions`	availability_conditions	No	The availability data for the event. The default is `all` sites.
`suite_spot_visible`	boolean	No	If false, it means that the event will not display in suite spot
`event_days`	[event_day]	Yes
`advanced_day_ordering`	advanced_day_ordering	No	Advanced Day Ordering (ADO)
`event_day_ordering`	event_day	No	Event Day Ordering (EDO)
`images`	string	No
`id`	string	No	The auto-assigned system document ID
`available_sites`	[site]	No
`created_at`	string	No	The last date and time the document was updated
`created_by`	string	No	The ID of the OPRA user or site that created this document
`updated_at`	string	No	The last date and time the document was updated
`updated_by`	string	No	The ID of the OPRA user or site that last updated this document

availability_conditions

Field Name	Type	Description
`condition`	string	The available condition. Enum: `all`, `include`, `exclude`
`sites`	When in event list, type is [entity_id] (site entity identifier) When in event detail, type is [site]	The related sites array

Field Name

Type

Description

condition

string

The available condition.

Enum: all, include, exclude

sites

When in event list, type is [entity_id] (site entity identifier)

When in event detail, type is [site]

The related sites array

event_day

Field Name	Type	Description
`start_date_time`	string	The event start in Coordinated Universal Time (UTC) date and time (ISO format)
`end_date_time`	string	The event end in UTC date and time (ISO format)

advanced_day_ordering

Field Name	Type	Description
`cutoff_date_time`	string	Coordinated Universal Time (UTC) date and time (ISO format)
`transition_cutoff_date_time`	string	UTC date and time (ISO format)

site

Field Name	Type	Required	Description
`id`	string	Yes	The auto-assigned system document identifier (ID)
`name`	string	No
`store_number`	string	No

_id

Field Name	Type	Description
`_id`	string	The auto-assigned system document identifier (ID)

name

Field Name	Type	Description
`name`	string

status

Field Name	Type	Description
`status`	string	The event status. Enum: `pending`, `open`, `closed`

Field Name

Type

Description

status

string

The event status.

Enum: pending, open, closed

company_id

Field Name	Type	Description
`company_id`	string	The identifier (ID) of the company who owns the document

entity_id

Field Name	Type	Description
`entity_id`	string	The auto-assigned unique identifier (UID) of this entity, set on creation. All future versions of this entity will share the same `entity_id`.

is_active

Field Name	Type	Description
`is_active`	boolean	The marking property is the essence of active documents. Sets in `true` by default.

created_by

Field Name	Type	Description
`created_by`	string	The identifier (ID) of the OPRA user or site that created this document

updated_by

Field Name	Type	Description
`updated_by`	string	The identifier (ID) of the OPRA user or site that last updated this document

created_at

Field Name	Type	Description
`created_at`	string	The last date and time the document was updated

updated_at

Field Name	Type	Description
`updated_at`	string	The last date and time the document was updated

Portal Events

Security

Endpoints

GET /{companyid}/events

GET /{companyid}/events/{event_id}

POST /{companyid}/events

PUT /{companyid}/events/{event_id}

DELETE /{companyid}/events/{event_id}

Data Models

events_document

event_external_create

event_external_update

event_document

availability_conditions

event_day

advanced_day_ordering

site

_id

name

status

company_id

entity_id

is_active

created_by

updated_by

created_at

updated_at

Search results