The eventattendee object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this eventattendee |
AttendeeCode: string optional read-only |
BusinessId: Id required |
CalendarEventId: Id required |
CheckedIn: bool optional |
CheckedInDate: DateTime? optional |
CoworkerId: Id optional |
CoworkerInvoiceId: int? optional |
CoworkerInvoiceNumber: string optional |
CoworkerInvoicePaid: bool optional |
DueDate: DateTime? optional read-only |
Email: string required |
EventProductId: Id required |
FullName: string required |
Invoiced: bool optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this eventattendee |
SystemId: string optional api-only
User defined data about this eventattendee. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"AttendeeCode": "012345",
"BusinessId": 12345678,
"CalendarEventId": 12345678,
"CheckedIn": false,
"CheckedInDate": ,
"CoworkerId": 12345678,
"CoworkerInvoiceId": ,
"CoworkerInvoiceNumber": "Abc123456",
"CoworkerInvoicePaid": false,
"DueDate": ,
"Email": "Attendee Email",
"EventProductId": 12345678,
"FullName": "Attendee FullName",
"Invoiced": false,
"UniqueId": "f04f18f9-8281-47ea-9f20-fdf39d2b6131",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a EventAttendee
This endpoint allows you to GET a list of eventattendees based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/content/eventattendees?...
π Requires role "EventAttendee-List"
Pagination querystring parameters
Lets control how many records to return at a time and their order. |
page integer optional
?page=1 |
size integer optional default=25
Sets the maximum number of records to return each page of results. ?size=25 |
orderby string optional default=Id
Sets the property to use when ordering the results of the search. ?orderby=Id |
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records. ?sort=ascending |
Search querystring parameters
Lets you search eventattendee records based on their different properties. |
Id number
?Id=12345678 |
EventAttendee_AttendeeCode string
?EventAttendee_AttendeeCode=... |
EventAttendee_Business Business
?EventAttendee_Business=... |
EventAttendee_CalendarEvent CalendarEvent
?EventAttendee_CalendarEvent=... |
EventAttendee_CheckedIn bool
?EventAttendee_CheckedIn=... |
EventAttendee_CheckedInDate DateTime?
?EventAttendee_CheckedInDate=... |
EventAttendee_Coworker Coworker
?EventAttendee_Coworker=... |
EventAttendee_CoworkerInvoiceId int?
?EventAttendee_CoworkerInvoiceId=... |
EventAttendee_CoworkerInvoiceNumber string
?EventAttendee_CoworkerInvoiceNumber=... |
EventAttendee_CoworkerInvoicePaid bool
?EventAttendee_CoworkerInvoicePaid=... |
EventAttendee_DueDate DateTime?
?EventAttendee_DueDate=... |
EventAttendee_Email string
?EventAttendee_Email=... |
EventAttendee_EventProduct EventProduct
?EventAttendee_EventProduct=... |
EventAttendee_FullName string
?EventAttendee_FullName=... |
EventAttendee_Invoiced bool
?EventAttendee_Invoiced=... |
EventAttendee_CalendarEventName string
?EventAttendee_CalendarEventName=... |
EventAttendee_EventProductName string
?EventAttendee_EventProductName=... |
EventAttendee_EventProductPrice string
?EventAttendee_EventProductPrice=... |
EventAttendee_EventProductCurrency_Code string
?EventAttendee_EventProductCurrency_Code=... |
EventAttendee_CoworkerFullName string
?EventAttendee_CoworkerFullName=... |
Range search querystring parameters
Lets you search eventattendee records based on a range of date or numeric values. |
To_EventAttendee_CreatedOn date
?To_EventAttendee_CreatedOn=2010-01-01T20:32 |
From_EventAttendee_CreatedOn date
?From_EventAttendee_CreatedOn=2010-01-01T20:32 |
To_EventAttendee_UpdatedOn date
?To_EventAttendee_UpdatedOn=2010-01-01T20:32 |
From_EventAttendee_UpdatedOn date
?From_EventAttendee_UpdatedOn=2010-01-01T20:32 |
To_EventAttendee_CheckedInDate date
?To_EventAttendee_CheckedInDate=2010-01-01T20:32 |
From_EventAttendee_CheckedInDate date
?From_EventAttendee_CheckedInDate=2010-01-01T20:32 |
To_EventAttendee_DueDate date
?To_EventAttendee_DueDate=2010-01-01T20:32 |
From_EventAttendee_DueDate date
?From_EventAttendee_DueDate=2010-01-01T20:32 |
To_EventAttendee_CoworkerInvoiceId number
?To_EventAttendee_CoworkerInvoiceId=0 |
From_EventAttendee_CoworkerInvoiceId number
?From_EventAttendee_CoworkerInvoiceId=10 |
Example request
GET https://spaces.nexudus.com/api/content/eventattendees?EventAttendee_FullName=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"CalendarEvent": ,
"EventProduct": ,
"Coworker": ,
"FullName": "Attendee FullName",
"Email": "Attendee Email",
"AttendeeCode": "012345",
"CheckedIn": false,
"CheckedInDate": ,
"Invoiced": false,
"DueDate": ,
"CoworkerInvoiceId": ,
"CoworkerInvoiceNumber": "Abc123456",
"CoworkerInvoicePaid": false,
"EventAttendeeCalendarEventName": "...",
"EventAttendeeEventProductName": "...",
"EventAttendeeEventProductPrice": "...",
"EventAttendeeEventProductCurrency_Code": "...",
"EventAttendeeCoworkerFullName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "14e9761f-a413-4424-bd8c-ea18914c2e80",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 25,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 60,
"TotalPages": 3
}
Find EventAttendees by IDs
Gets one or more eventattendee records based on their Id.GET https://spaces.nexudus.com/api/content/eventattendees?EventAttendee_Id=[:id1,:id2,...]
π Requires role "EventAttendee-List"
Querystring parameters |
EventAttendee_Id: array requried
?EventAttendee_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/content/eventattendees?EventAttendee_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"CalendarEvent": ,
"EventProduct": ,
"Coworker": ,
"FullName": "Attendee FullName",
"Email": "Attendee Email",
"AttendeeCode": "012345",
"CheckedIn": false,
"CheckedInDate": ,
"Invoiced": false,
"DueDate": ,
"CoworkerInvoiceId": ,
"CoworkerInvoiceNumber": "Abc123456",
"CoworkerInvoicePaid": false,
"EventAttendeeCalendarEventName": "...",
"EventAttendeeEventProductName": "...",
"EventAttendeeEventProductPrice": "...",
"EventAttendeeEventProductCurrency_Code": "...",
"EventAttendeeCoworkerFullName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "9f99b1da-94ba-4f14-874c-9a602245f76d",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single EventAttendee by Id
Gets one eventattendee record by its Id.GET https://spaces.nexudus.com/api/content/eventattendees/:Id
π Requires role "EventAttendee-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/content/eventattendees/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"AttendeeCode": "012345",
"BusinessId": 12345678,
"CalendarEventId": 12345678,
"CheckedIn": false,
"CheckedInDate": ,
"CoworkerId": 12345678,
"CoworkerInvoiceId": ,
"CoworkerInvoiceNumber": "Abc123456",
"CoworkerInvoicePaid": false,
"DueDate": ,
"Email": "Attendee Email",
"EventProductId": 12345678,
"FullName": "Attendee FullName",
"Invoiced": false,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "3f2d61fd-2bd8-4a66-adf6-5ff4b584ae66",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new EventAttendee
Creates a new eventattendee.POST https://spaces.nexudus.com/api/content/eventattendees
π Requires role "EventAttendee-Create"
Body parameters |
BusinessId: number required |
CalendarEventId: number required |
EventProductId: number required |
CoworkerId: number optional |
FullName: string required |
Email: string required |
CheckedIn: bool optional |
CheckedInDate: DateTime? optional |
Invoiced: bool optional |
CoworkerInvoiceId: int? optional |
CoworkerInvoiceNumber: string optional |
CoworkerInvoicePaid: bool optional |
Example request
POST https://spaces.nexudus.com/api/content/eventattendees Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"CalendarEventId": 12345678,
"EventProductId": 12345678,
"CoworkerId": 12345678,
"FullName": "Attendee FullName",
"Email": "Attendee Email",
"CheckedIn": false,
"CheckedInDate": ,
"Invoiced": false,
"CoworkerInvoiceId": ,
"CoworkerInvoiceNumber": "Abc123456",
"CoworkerInvoicePaid": false,
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully created.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Update EventAttendee
Updates an existing eventattendee.PUT https://spaces.nexudus.com/api/content/eventattendees
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "EventAttendee-Edit"
Body parameters |
Id: number required
The unique Id of the eventattendee to update. |
BusinessId: number cleared if missing |
CalendarEventId: number cleared if missing |
EventProductId: number cleared if missing |
CoworkerId: number cleared if missing |
FullName: string cleared if missing |
Email: string cleared if missing |
CheckedIn: bool cleared if missing |
CheckedInDate: DateTime? cleared if missing |
CoworkerInvoiceId: int? cleared if missing |
CoworkerInvoiceNumber: string cleared if missing |
CoworkerInvoicePaid: bool cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/content/eventattendees Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"CalendarEventId": 12345678,
"EventProductId": 12345678,
"CoworkerId": 12345678,
"FullName": "Attendee FullName",
"Email": "Attendee Email",
"CheckedIn": false,
"CheckedInDate": ,
"Invoiced": false,
"CoworkerInvoiceId": ,
"CoworkerInvoiceNumber": "Abc123456",
"CoworkerInvoicePaid": false,
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully updated.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Delete EventAttendee
Deletes an existing eventattendee by its Id.DELETE https://spaces.nexudus.com/api/content/eventattendees/:Id
π Requires role "EventAttendee-Delete"
URL parameters |
Id: number required
The unique Id of the eventattendee to update. |
Example request
DELETE https://spaces.nexudus.com/api/content/eventattendees/12345678 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "The record was deleted successfully.",
"Value": null,
"OpenInDialog": false,
"RedirectURL": null,
"JavaScript": null,
"Errors": null
}
Commands
Commands allow to perform actions against one or more eventattendee records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.Get Commands
Get all commands available to run for eventattendee records.GET https://spaces.nexudus.com/api/content/eventattendees/commands
Example request
GET https://spaces.nexudus.com/api/content/eventattendees/commands Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
[
{
"Key": "COMMAND_KEY_1",
"Name": "Command 1 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": false,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": false,
"NeedsEntitiesToRun": true,
"Order": 2,
"RequiresParameters": []
},
{
"Key": "COMMAND_KEY_2",
"Name": "Command 2 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": true,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": true,
"NeedsEntitiesToRun": true,
"Order": 10,
"RequiresParameters":
[
{
"Name": "Parameter 1 description",
"Type": "string",
},
{
"Name": "Parameter 2 description",
"Type": "Boolean",
}
]
},
...
]
Run Command
Runs a command based on its Key and one or more eventattendee record IDs.POST https://spaces.nexudus.com/api/content/eventattendees/runacommandπ Requires role "EventAttendee-Edit"
Example request
POST https://spaces.nexudus.com/api/content/eventattendees/runcommand Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Ids":[1329961649],
"Parameters":
[
{
"Type": "string"
"Value":987654321
},
{
"Type": "Boolean",
"Value":true
},
...
],
"Key":"COMMAND_KEY_2"
}
Example valid response
{
"Errors": null
"JavaScript": null
"Message": "Result description"
"OpenInDialog": false
"OpenInWindow": false
"RedirectURL": null
"Status": 200
"UpdatedBy": "email@example.net"
"UpdatedOn: "2020-06-04T11:40:20Z"
"Value: {Id: 12345678}
"WasSuccessful: true
}
Comments
Please sign in to leave a comment.