Home > Agendize Scheduling

Conference Sessions


{ "id": {string}, "text": {string}, "color": {string}, "numberOfConferences": {integer} }
id string Identifier of the tag. read-only
text text Text of the tag. writable
color string Color of the tag. Format: #RRGGBB read-only
numberOfConference string Number of conference which use the tag read-only

Delete

Deletes an entry on the conferences tag list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE https://api.agendize.com/conferences/api/1.0/tags/{tagId}

Parameters

Parameter name Value Description
Path parameters
sessionId string Tag identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


Get

Returns an entry of the conferences tag list

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/conferences/api/1.0/tags/<{tagId}

Parameters

Parameter name Value Description
Path parameters
tagId string Tag identifier.
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,title").

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Tag resource in the response body.


List

Returns entries on the conferences tag list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/conferences/api/1.0/tags

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Tag Resource] }

Insert

Adds an entry to the conferences tag list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/conferences/api/1.0/tags

Request body

In the request body, supply a Tag resource with the following properties:

Parameter name Value Description
Required Properties
text object The text of the tag. writable
Optional Properties
color string Color of the tag. Format: #RRGGBB.

Response

If successful, this method returns a Tag resource in the response body.


Update

Updates an entry on the conference session list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT https://api.agendize.com/conferences/api/1.0/conferences/{conferenceId}/sessions/{sessionId}

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.
sessionId string Session identifier.

Request body

In the request body, supply a Session resource with the following properties:

Parameter name Value Description
start object The start time of the session. writable
start.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). writable
start.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. writable
status string Status of the session. Values: "opened", "closed".

Response

If successful, this method returns a Session resource in the response body.