id |
string |
Identifier of the registration. | read-only |
client |
object |
Client details | writable |
client.id |
string |
Identifier of the client. | writable |
client.firstName |
string |
First name of the client. | read-only |
client.lastName |
string |
Last name of the client. | read-only |
client.emailAddress |
string |
Email address of the client. | read-only |
client.phoneNumber |
string |
Phone number of the client. | read-only |
status |
string |
Status of the registration. Values: "accepted", "cancelled". "waitingList". | writable for "accepted" and "waitingList". Read-Only for "cancelled". |
seats |
integer |
Number of seats reserved. Default: 1 | writable |
registered |
object |
The registration date time. | read-only |
registered.dateTime |
string |
The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). | read-only |
registered.timeZone |
string |
The time zone. Possible values can be found here. The default value is the time zone of the company. | read-only |
cipherId |
string |
Ciphered identifier of the registration. | read-only |
source |
string |
The source of the registration. | read-only |
sourceType |
string |
The source type of the registration. Values: "api", "widget". | read-only |
cancelReason |
string |
If the registration has been cancelled, the reason of the cancellation. | read-only |
cancelSource |
string |
If the registration has been cancelled, the source of the cancellation. | read-only |
cancelled |
object |
If the registration has been canelled, the cancellation date time. | read-only |
cancelled.dateTime |
string |
The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). | read-only |
cancelled.timeZone |
string |
The time zone. Possible values can be found here. The default value is the time zone of the company. | read-only |
webLink |
string |
Web link of the conference registration. | read-only |
form |
object |
The filled form of the registration, see description below | writable |
Parameter name | Value | Description | Notes |
---|---|---|---|
FormItem.id |
string |
Id of the field. Can not be empty. | |
FormItem.type |
string |
Type of the field. Values:
|
|
FormItem.title |
string |
Title of the field. | |
FormItem.bind |
string |
Binding string form special fields. Values:
|
|
FormItem.bindGroup |
string |
Binding group string form special group of fields. Values:
|
|
FormItem.externalId |
string |
External identifier of this field. When this value is set up, this field would be fulfilled by HTTP query parameters on the registration> widget. | |
FormItem.help |
string |
Help text of the field. | |
FormItem.placeholder |
string |
Placeholder of the field. | |
FormItem.mandatory |
boolean |
If the field is mandatory. | |
FormItem.visible |
boolean |
If the field is visible by client. | |
FormItem.otherValue |
boolean |
Activate or deactivate the possibility to add a custom value to the field. Available for type radio, checkbox and select. | |
FormItem.category |
boolean |
Activate or deactivate the possibility to group values by category. Available only for type select. | |
FormItem.multiple |
boolean |
Activate or deactivate the possibility to select several values. Available only for type select. | |
FormItem.value |
string |
Value of the field. For multi values fields (radio, checkbox and select), use "values" instead. | |
FormItem.values |
list |
Values list of the field. Available for type radio, checkbox and select. | |
FormItem.values[].id |
string |
Identifier of the field value. | |
FormItem.values[].name |
string |
Name of the field value. | |
FormItem.values[].value |
string |
Value of the field value. | |
FormItem.values[].values |
list |
List of values of the form field value. Available only for type select with option category set to True | |
FormItem.values[].values[].id |
string |
Identifier of the form field value. Available only for type select with option category set to True | |
FormItem.values[].values[].name |
string |
Name of the form field value. Available only for type select with option category set to True | |
FormItem.values[].values[].value |
string |
Value of the form field value. Available only for type select with option category set to True | |
FormItem.valueFormat |
object |
Input rules. | |
FormItem.valueFormat.maxLength |
number |
Value maximum length. | |
FormItem.valueFormat.minLength |
number |
Value minimum length. | |
FormItem.valueFormat.regexType |
string |
Type of regex. | |
FormItem.valueFormat.regexValue |
string |
Value of regex. | |
FormItem.valueFormat.valueFormat |
string |
Type or format
|
|
FormItem.zonedDateTime |
object |
If the field is a date type, the value is formatted and returned with his timezone | Read only |
FormItem.zonedDateTime.dateTime |
object |
The value of the field formatted. For example '2011-12-03T10:15:30' | Read only |
FormItem.zonedDateTime.timeZone |
object |
The date timezone. For example 'Europe/Paris' | Read only |
FormItem.subItem |
list |
List of sub FormItem, available for crm-address field and crm-name field. |
Deletes an entry on the conference session list.
Authentication is required to execute this request. Please refer to Authentication for more.
{conferenceId}
/sessions/{sessionId}
/registrations/{registrationId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
conferenceId |
string |
Conference identifier or external id. |
sessionId |
string |
Session identifier. |
registrationId |
string |
Registration identifier. |
If needed, supply a request body with this method.
Parameter name | Value | Description | |
---|---|---|---|
reason |
string |
Reason of the cancellation. | |
source |
string |
Source of the cancellation. |
If successful, this method returns an empty response body.
Returns an entry of the conference session list
Authentication is required to execute this request. Please refer to Authentication for more.
{conferenceId}
/sessions/{sessionId}
/registrations/{registrationId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
conferenceId |
string |
Conference identifier or external id. |
sessionId |
string |
Session identifier. |
registrationId |
string |
Registration identifier. |
Optional query parameters | ||
fields |
string |
Specify the fields returned. Comma separated field names (ex: "id,title"). |
Do not supply a request body with this method.
If successful, this method returns a Registration resource in the response body.
Returns entries on the conference session list.
Authentication is required to execute this request. Please refer to Authentication for more.
{conferenceId}
/sessions/{sessionId}
/registrationsParameter 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"). |
withCancelled |
boolean |
Specify if cancelled registrations need to be returned too. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Adds an entry to the conference session list.
Authentication is required to execute this request. Please refer to Authentication for more.
{conferenceId}
/sessions/{sessionId}
/registrationsParameter name | Value | Description |
---|---|---|
Path parameters | ||
conferenceId |
string |
Conference identifier or external id. |
sessionId |
string |
Session identifier. |
In the request body, supply a Registration resource with the following properties:
Parameter name | Value | Description | |
---|---|---|---|
Required Properties | |||
client |
object |
Client details | writable |
client.id |
string |
Identifier of the client. | writable |
Optional Properties | |||
seats |
integer |
Number of seats reserved. Default: 1 | writable |
status |
string |
Status of the registration. Values: "accepted", "waitingList". | writable |
form |
object |
The filled form of the registration, see description below | writable |
If successful, this method returns a Registration resource in the response body.
Updates an entry on the conference session list.
Authentication is required to execute this request. Please refer to Authentication for more.
{conferenceId}
/sessions/{sessionId}
/registrations/{registrationId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
conferenceId |
string |
Conference identifier or external id. |
sessionId |
string |
Session identifier. |
registrationId |
string |
Registration identifier. |
In the request body, supply a Registration resource with the following properties:
Parameter name | Value | Description | |
---|---|---|---|
Optional Properties | |||
client |
object |
Client details | writable |
client.id |
string |
Identifier of the client. | writable |
seats |
integer |
Number of seats reserved. Default: 1 | writable |
status |
string |
Status of the registration. Values: "accepted", "waitingList". | writable |
form |
object |
The filled form of the registration, see description below | writable |
If successful, this method returns a Registration resource in the response body.
Watch for changes to Conference Registration resources.
Authentication is required to execute this request. Please refer to Authentication for more.
The watch send a Conference Registration resource in the request body
{sessionId}
/registrations/watchParameter name | Value | Description |
---|---|---|
Path parameters | ||
sessionId |
string |
Session identifier or "0" for all sessions. |
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. |
If successful, this method returns a watch resource in the response body.
With JSON, only for string value:
With string to support typed values:
Replacement string can by defined with jsonpath expressions.