Skip to main content

Planning

The Planning object contains planning data and all data related to the planning.

Planning Object

Payload Details

idstring

Unique identifier for the planning.

event_idstring

Unique identifier for the event.

community_idstring

Unique identifier for the community.

ticket_urlstring

Url of the ticket associated to the planning.

is_overlapping_allowedbool

Is overlapping allowed on this planning.

community_profile_can_registerbool

Can people can register directly.

max_seatsuint32

The maximum number of seats allowed for this planning.

hide_attendeesbool

Can we display attendees on the planning.

is_ratablebool

Can attendees rate this planning.

formatstring

The meeting format.

access_control_modestring

The access control mode set up for this planning.

on_demandobject

If the planning is OnDemand, here are additional informations.

on_demand.idstring

Unique identifier for the on-demand object.

on_demand.available_atstring

Start date of availability of the on-demand video.

on_demand.available_untilstring

End date of availability of the on-demand video.

on_demand.is_publicstring

Is the on-demand session public.

on_demand.VideoEmbeddedVideo

The video of the on-demand session.

on_demand.UploadedVideoIdstring

The identifier of the uploaded video.

on_demand.created_atstring

Creation date of the on-demand object.

on_demand.updated_atstring

Update date of the on-demand object.

on_demand.deleted_atstring

Deletion date of the on-demand object.

live_streamobject

If the planning is LiveStream, here are additional informations.

live_stream.idstring

Unique identifier for the live-stream object.

live_stream.available_atstring

Start date of availability of the live-stream.

live_stream.available_untilstring

End date of availability of the live-stream.

live_stream.is_publicstring

Is the live-stream session public.

live_stream.is_recordedstring

Is the live-stream session recorded.

live_stream.StreamEmbeddedVideo

The stream of the live-stream.

live_stream.created_atstring

Creation date of the on-demand object.

live_stream.updated_atstring

Update date of the on-demand object.

live_stream.deleted_atstring

Deletion date of the on-demand object.

pre_recordedobject

If the planning is PreRecorded, here are additional informations.

pre_recorded.idstring

Unique identifier for the pre-recorded object.

pre_recorded.available_atstring

Start date of availability of the pre-recorded video.

pre_recorded.available_untilstring

End date of availability of the pre-recorded video.

pre_recorded.is_publicstring

Is the pre-recorded session public.

pre_recorded.VideoEmbeddedVideo

The video of the pre-recorded session.

pre_recorded.UploadedVideoIdstring

The identifier of the uploaded video.

pre_recorded.created_atstring

Creation date of the pre-recorded object.

pre_recorded.updated_atstring

Update date of the pre-recorded object.

pre_recorded.deleted_atstring

Deletion date of the pre-recorded object.

roundtableobject

If the planning is Roundtable, here are additional informations.

roundtable.idstring

Unique identifier for the roundtable object.

roundtable.starts_atstring

Start date of the roundtable.

roundtable.ends_atstring

End date of the roundtable.

roundtable.max_participantsuint32

Maximum number of participants to the roundtable.

roundtable.vonage_session_idstring

Third party vonage session id.

roundtable.providerstring

Currently only one provider: Vonage.

roundtable.video_background_image_urlstring

Media file url describing the video background image.

roundtable.audio_onlybool

Is roundtable audio only.

roundtable.moderated_stagebool

Does the roundtable have a moderated stage.

roundtable.deleted_atstring

Deletion date of the roundtable object.

attendeesarray of object

List of attendees to the planning.

attendees.idstring

Unique identifier for the attendee.

attendees.user_idstring

Unique identifier for the user attending the planning.

attendees.sourcestring

Database or service from which this attendee was created.

attendee.created_atstring

Creation date of the attendee.

attendee.updated_atstring

Update date of the attendee.

attendee.deleted_atstring

Deletion date of the attendee.

List of custom fields attached to the planning.

evaluationsarray of object

List of evaluations to the planning.

evaluations.idstring

Unique identifier for the evaluation.

evaluations.user_idstring

Unique identifier for user who did the evaluation.

evaluations.commentstring

Evaluation comment of the planning.

evaluations.ratingfloat64

Evaluation rating of the planning.

evaluation.created_atstring

Creation date of the evaluation.

evaluation.updated_atstring

Update date of the evaluation.

exhibitor_idsarray of strings

List of exhibitor id participating to the planning.

client_idsarray of strings

List of external id associated to the planning.

created_atstring

Creation date of the planning.

attendee.updated_atstring

Update date of the planning.

attendee.deleted_atstring

Deletion date of the planning.