Agendize Developers API

Home > Agendize Scheduling

Conference Sessions

{ "id": {string}, "start": { "dateTime": {string}, "timeZone": {string} }, "status": {string}, "cipherId": {string}, "webLink": {string} }
id string Identifier of the session. read-only
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". read-only
cipherId string Ciphered identifier of the session. read-only
webLink string Web link of the conference session widget. read-only

Delete

Deletes an entry on the conference session 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/conferences/{conferenceId}/sessions/{sessionId}

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.
sessionId string Session 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 conference session 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/conferences/{conferenceId}/sessions/{sessionId}

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.
sessionId string Session 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 Session resource in the response body.

List

Returns entries on the conference session 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/conferences/{conferenceId}/sessions

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.
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 response body with the following structure:

{ items: [Session Resource] }

Insert

Adds an entry to the conference session 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/conferences/{conferenceId}/sessions

Parameters

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

Request body

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

Parameter name Value Description
Required Properties
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
Optional Properties
status string Status of the session. Values: "opened", "closed".

Response

If successful, this method returns a Session 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
status string Status of the session. Values: "opened", "closed".

Response

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

Watch

Watch for changes to Conference Session resources.

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

The watch send a Conference Session resource in the request body

Request

HTTP Request

POST https://api.agendize.com/conferences/api/1.0/conferences/{conferenceId}/sessions/watch

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or "0" for all conferences.

Request body

{ "address": {string}, "name": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { {name}: {string} }, "schema": {object} "method": {string}, "status": {string}, "oauth2Auth": { "grantType": {string}, "clientId": {string}, "clientSecret": {string}, "refreshToken": {string}, "authUrl": {string}, "accessTokenUrl": {string}, "redirectUri": {string} }, "signature": { "enabled": {boolean}, "cryptoKeyIds": [ {string} ] } }
Required Properties
address string The address where notifications are delivered for this watch.
Optional Properties
name string Name of the watch.
basicAuth string Credentials parameters for HTTP Basic authentication on the destination watch address. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Password.
httpRequestHeader string Custom header parameters to send with the http request on the destination watch address.
httpRequestHeader.name string header parameter name.
schema object Custom json schema to apply for resource properties.
method string HTTP Method to use for sending content. DELETE Method doesn't accept body content.
status string Status of the watcher. Values: "enabled", "disabled"
oauth2Auth string Credentials parameters for HTTP OAuth2 authentication on the destination watch address. Only if you use this authentication method.
oauth2Auth.grantType string OAuth2 grant type. Values: "refresh_token" (default), "client_credentials".
oauth2Auth.clientId string OAuth2 client id.
oauth2Auth.refreshToken string OAuth2 refresh token. Only for grantType "refresh_token"
oauth2Auth.authUrl string OAuth2 interactive end point to initiate the generation of the refresh token. Only for grantType "refresh_token"
oauth2Auth.accessTokenUrl string OAuth2 end point to generation an access token from the refresh token.
oauth2Auth.scope string OAuth2 api scope. Only for grantType "refresh_token"
signature object Produces a crypto signature of the watched content.
signature.enabled boolean Sets if the signature is enabled or not.
signature.cryptoKeyIds list Arrays of string of crypto keys identifier.

Response

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

Examples of schema:

With JSON, only for string value:

{ "schema": { "my_id_key": "{id}", "dataContent": { "givenName": "{firstName}" } } }

With string to support typed values:

{ "schema": "\"my_id_key\": ${$.id}, \"dataContent\": { \"fullName\": \"${$.firstName} ${$.lastName}\"}" }

Replacement string can by defined with jsonpath expressions.

Watch event supported

  • Conference session added in dashboard or API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: created
  • Conference session modified in dashboard or API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: updated
  • Conference session deleted in dashboard or API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: deleted

List All

Returns entries of all sessions.

This API function is a help to build your own conference sessions dashboard.

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/sessions

Parameters

Parameter name Value Description
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,title").
startDate string Upper bound (exclusive) for start date of the sessions. Format: yyyy-MM-dd
endDate string Lower bound (exclusive) for start date of the session. Format: yyyy-MM-dd
count integer Number of session asked. Default: 20.
itemStart integer Start count range. Default: 20.
orderBy string Can order session by a key. Values: "start", "status", "conference.capacity", "conference.title", "conference.visibility", "conference.duration". Default: start.
orderDirection string Order direction. Values: "asc" for ascending, "desc", for descending. Default: "asc".

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: [ { "id": {string}, "start": { "dateTime": {string}, "timeZone": {string} }, "conference": { "title": {string}, "id": {string}, "capacity": {integer}, "duration": {integer}, "availability": {string}, "cipherId": {string}, "numberOfSpeakers": {integer}, "numberOfInvitees": {integer}, "selfLink": {string}, "locationType": {string}, "tags": [ { "id": {string}, "text": {string} } ], }, "status": {string}, "numberOfRegistrations": {integer}, "numberOfRegisteredSeats": {integer}, "cipherId": {string}, "selfLink": {string} } ], totalCount: {integer}, count: {integer} }
Parameter name Value Description
items list All session resources.
id string Identifier of the session. read-only
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.
conference.title string Title of the conference.
conference.id string Identifier of the conference.
conference.capacity integer Number of seats of the conference.
conference.duration integer Duration of the conference, in minutes.
conference.availability string Availability of the conference. Values: "public", "private".
conference.cipherId string Ciphered identifier of the conference.
conference.numberOfSpeakers integer Number of speakers of the conference.
conference.numberOfInvitees integer Number of invitees of the conference.
conference.selfLink string API link of the conference.
conference.locationType string Type of location. Values: "address", "link", "custom", "schedulingCompanyAddress".
conference.tags list List of tags of conference.
conference.tags[].id list Identifier of the tag.
conference.tags[].text list Text of the tag.
status string Status of the session. Values: "opened", "closed".
cipherId string Ciphered identifier of the session.
selfLink string API link of the session.
totalCount integer Number of total sessions.
count integer Number of asked sessions.

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.