calendar_v1_registrations Script API

Ben Tiedt — Wed, 20 Nov 2019 14:52:56 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:52:56

Calendar Event Registration Utility methods for scripted widgets

Properties
Cancel
Confirm
Create
Get
List
Show
Update

Properties

Name	Access	Type	Description
Current	Read	`[[EventRegistration Script API Type\|EventRegistration]]`	Current

Methods

Cancel

Velocity

#set($eventRegistrationResponse = $calendar_v1_registrations.Cancel($token))

JavaScript

var eventRegistrationResponse = calendar_v1_registrations.Cancel(token);

Parameters

Name	Type	Description	Required	Default	Options
token	`Guid`	Token	Required

Returns

[[EventRegistration Script API Type|EventRegistration]]

Confirm

Velocity

#set($eventRegistrationResponse = $calendar_v1_registrations.Confirm($token))

JavaScript

var eventRegistrationResponse = calendar_v1_registrations.Confirm(token);

Parameters

Name	Type	Description	Required	Default	Options
token	`Guid`	Token	Required

Returns

[[EventRegistration Script API Type|EventRegistration]]

Create

Velocity

#set($eventRegistrationResponse = $calendar_v1_registrations.Create($eventId, "%{ Email = $emailArg, FirstName = $firstNameArg, LastName = $lastNameArg, Status = $statusArg, UserId = $userIdArg }"))

JavaScript

var eventRegistrationResponse = calendar_v1_registrations.Create(eventId, { Email: emailArg, FirstName: firstNameArg, LastName: lastNameArg, Status: statusArg, UserId: userIdArg });

Parameters

Name	Type	Description	Required	Options
eventId	`Int32`	Event Id	Required
Email	`String`	Email	Optional
FirstName	`String`	First Name	Optional
LastName	`String`	Last Name	Optional
Status	`String`	Status	Optional	Cancelled, Confirmed, Invited, NotApproved
UserId	`Int32`	User Id	Optional

Returns

[[EventRegistration Script API Type|EventRegistration]]

Get

Get Overload 1

Velocity

#set($eventRegistrationResponse = $calendar_v1_registrations.Get($eventId, $userId))

JavaScript

var eventRegistrationResponse = calendar_v1_registrations.Get(eventId, userId);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
userId	`Int32`	User Id	Required

Get Overload 2

Velocity

#set($eventRegistrationResponse = $calendar_v1_registrations.Get($token))

JavaScript

var eventRegistrationResponse = calendar_v1_registrations.Get(token);

Parameters

Name	Type	Description	Required	Default	Options
token	`Guid`	Token	Required

Returns

[[EventRegistration Script API Type|EventRegistration]]

List

Velocity

#set($pagedListResponse = $calendar_v1_registrations.List($eventId, "%{  }"))

JavaScript

var pagedListResponse = calendar_v1_registrations.List(eventId, {  });

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required

Returns

[[PagedList Script API Type|PagedList]] of [[EventRegistration Script API Type|EventRegistration]]

Show

Velocity

#set($eventRegistrationResponse = $calendar_v1_registrations.Show($eventId, $email))

JavaScript

var eventRegistrationResponse = calendar_v1_registrations.Show(eventId, email);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
email	`String`	Email	Required

Returns

[[EventRegistration Script API Type|EventRegistration]]

Update

Velocity

#set($eventRegistrationResponse = $calendar_v1_registrations.Update($token, "%{ Email = $emailArg, FirstName = $firstNameArg, LastName = $lastNameArg, Status = $statusArg, UserId = $userIdArg }"))

JavaScript

var eventRegistrationResponse = calendar_v1_registrations.Update(token, { Email: emailArg, FirstName: firstNameArg, LastName: lastNameArg, Status: statusArg, UserId: userIdArg });

Parameters

Name	Type	Description	Required	Options
token	`Guid`	Token	Required
Email	`String`	Email	Optional
FirstName	`String`	First Name	Optional
LastName	`String`	Last Name	Optional
Status	`String`	Status	Optional	Cancelled, Confirmed, Invited, NotApproved
UserId	`Int32`	User Id	Optional

Returns

[[EventRegistration Script API Type|EventRegistration]]