event_mgr_list
Back to SOAP Architecture Method Reference
Description
The event_mgr_list method lists the details of the designated Events.
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| domain_id | The unique #ID of the domain. | bstypes:ResourceId | R |
| event_id | The unique #ID of the event. | bstypes:ResourceId | O |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of this event. | bstypes:ResourceId | R |
| name | The name of this event | string | R |
| active | Whether this event is active | boolean | R |
| container_id | The ID# of the folder where this event is. | bstypes:ResourceId | R |
| domain_id | The unique ID# of the domain. | bstypes:ResourceId | R |
| state | The reservation state of this event. | bstypes:ReservationState | R |
| start_date | The start date of this event. | bstypes:SimpleDate | R |
| end_date | The end date of this event. | bstypes:SimpleDate | R |
| start_time | The start time of this event. | bstypes:SimpleTime | R |
| end_time | the end time of this event. | bstypes:SimpleTime | R |
| duration_msec | The duration in milliseconds of this evnet. | int | R |
| creation_user_id | The #ID of the user who created this event. | bstypes:ResourceId | R |
| creation_tm | The Date Time at which the event was created. | bstypes:SimpleDateTime | R |
| promoter_user_id | The #ID of the user who promoted this event. | bstypes:ResourceId | R |
| promotion_time | The Date Time at which the event was promoted. | bstypes:SimpleDateTime | R |
| estimated_reps | The estimated number of repetitions of this event. | long | R |
| reps_calculated_on | The Date Time at which the repetitions were calculated. | bstypes:SimpleDateTime | R |
| default_schedule_id | The #ID of the default schedule for this event. | bstypes:ResourceId | R |
| default_fullscreen | Whether this event runs in fullscreen mode. | boolean | R |
| occurrence | A string describing the occurrence frequency of this event. | string | R |
| default_attributes | Lists the attributes of the custom geometry for this event in a comma seperated key-value pairs. Example: height=10,width=10,unit=1 means that this event will have a custom geometry of 10% in height and 10% in width. |
string | R |
| bmb_host_id | The #ID of the Broadsign Creator Player assigned to this event. | bstypes:ResourceId | R |