The user object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this user |
AccessToken: string optional |
Active: bool optional |
APIAccess: bool optional |
Devices: string optional |
Email: string required |
EnablePassportAccess: bool optional read-only |
FullName: string required |
IsAdmin: bool optional |
LastAccess: DateTime? optional |
MustResetPassword: bool optional |
NewPassword: string optional |
NextHelpDeskMessageReminder: DateTime? optional |
OnAccessControlErrors: bool optional |
OnBookingChange: bool optional |
OnHelpDeskMsg: bool optional |
OnNewBlogComment: bool optional |
OnNewEmail: bool optional |
OnNewEventComment: bool optional |
OnNewMember: bool optional |
OnNewWallPost: bool optional |
OnPlaformInvoices: bool optional |
OnProfileChanges: bool optional |
OnPurchases: bool optional |
OnTariffChange: bool optional |
OnVisitorRegistration: bool optional |
PassportCardNumber: string optional read-only |
PassportNumber: string optional read-only |
PreferredLanguageId: Id optional |
ReceiveCommunityDigest: bool optional |
ReceiveEveryMessage: bool optional |
Validated: bool optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this user |
SystemId: string optional api-only
User defined data about this user. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"AccessToken": "hush",
"Active": false,
"APIAccess": false,
"Devices": "Devices",
"Email": "email@email.com",
"EnablePassportAccess": false,
"FullName": "Full Name",
"IsAdmin": false,
"LastAccess": ,
"MustResetPassword": false,
"NewPassword": "password",
"NextHelpDeskMessageReminder": ,
"OnAccessControlErrors": false,
"OnBookingChange": false,
"OnHelpDeskMsg": false,
"OnNewBlogComment": false,
"OnNewEmail": false,
"OnNewEventComment": false,
"OnNewMember": false,
"OnNewWallPost": false,
"OnPlaformInvoices": false,
"OnProfileChanges": false,
"OnPurchases": false,
"OnTariffChange": false,
"OnVisitorRegistration": false,
"PassportCardNumber": "Abc123456",
"PassportNumber": "Abc123456",
"PreferredLanguageId": 12345678,
"ReceiveCommunityDigest": false,
"ReceiveEveryMessage": false,
"Validated": false,
"UniqueId": "abe3edce-6df2-4e91-be9b-3ae7f7331a58",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a User
This endpoint allows you to GET a list of users based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/sys/users?...
π Requires role "User-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 user records based on their different properties. |
Id number
?Id=12345678 |
User_AccessToken string
?User_AccessToken=... |
User_Active bool
?User_Active=... |
User_APIAccess bool
?User_APIAccess=... |
User_Devices string
?User_Devices=... |
User_Email string
?User_Email=... |
User_EnablePassportAccess bool
?User_EnablePassportAccess=... |
User_FullName string
?User_FullName=... |
User_IsAdmin bool
?User_IsAdmin=... |
User_LastAccess DateTime?
?User_LastAccess=... |
User_MustResetPassword bool
?User_MustResetPassword=... |
User_NewPassword string
?User_NewPassword=... |
User_NextHelpDeskMessageReminder DateTime?
?User_NextHelpDeskMessageReminder=... |
User_OnAccessControlErrors bool
?User_OnAccessControlErrors=... |
User_OnBookingChange bool
?User_OnBookingChange=... |
User_OnHelpDeskMsg bool
?User_OnHelpDeskMsg=... |
User_OnNewBlogComment bool
?User_OnNewBlogComment=... |
User_OnNewEmail bool
?User_OnNewEmail=... |
User_OnNewEventComment bool
?User_OnNewEventComment=... |
User_OnNewMember bool
?User_OnNewMember=... |
User_OnNewWallPost bool
?User_OnNewWallPost=... |
User_OnPlaformInvoices bool
?User_OnPlaformInvoices=... |
User_OnProfileChanges bool
?User_OnProfileChanges=... |
User_OnPurchases bool
?User_OnPurchases=... |
User_OnTariffChange bool
?User_OnTariffChange=... |
User_OnVisitorRegistration bool
?User_OnVisitorRegistration=... |
User_PassportCardNumber string
?User_PassportCardNumber=... |
User_PassportNumber string
?User_PassportNumber=... |
User_PreferredLanguage Language
?User_PreferredLanguage=... |
User_ReceiveCommunityDigest bool
?User_ReceiveCommunityDigest=... |
User_ReceiveEveryMessage bool
?User_ReceiveEveryMessage=... |
User_Validated bool
?User_Validated=... |
User_Businesses List of Business
?User_Businesses=... |
User_UserRoles List of UserRole
?User_UserRoles=... |
User_ChatRooms List of ChatRoom
?User_ChatRooms=... |
Range search querystring parameters
Lets you search user records based on a range of date or numeric values. |
To_User_CreatedOn date
?To_User_CreatedOn=2010-01-01T20:32 |
From_User_CreatedOn date
?From_User_CreatedOn=2010-01-01T20:32 |
To_User_UpdatedOn date
?To_User_UpdatedOn=2010-01-01T20:32 |
From_User_UpdatedOn date
?From_User_UpdatedOn=2010-01-01T20:32 |
To_User_LastAccess date
?To_User_LastAccess=2010-01-01T20:32 |
From_User_LastAccess date
?From_User_LastAccess=2010-01-01T20:32 |
To_User_NextHelpDeskMessageReminder date
?To_User_NextHelpDeskMessageReminder=2010-01-01T20:32 |
From_User_NextHelpDeskMessageReminder date
?From_User_NextHelpDeskMessageReminder=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/sys/users?User_FullName=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"FullName": "Full Name",
"Email": "email@email.com",
"AccessToken": "hush",
"PreferredLanguage": ,
"NewPassword": "password",
"PassportNumber": "Abc123456",
"PassportCardNumber": "Abc123456",
"EnablePassportAccess": false,
"Active": false,
"IsAdmin": false,
"APIAccess": false,
"Validated": false,
"MustResetPassword": false,
"LastAccess": ,
"Devices": "Devices",
"OnNewEmail": false,
"OnHelpDeskMsg": false,
"OnNewWallPost": false,
"OnNewMember": false,
"OnProfileChanges": false,
"OnNewBlogComment": false,
"OnNewEventComment": false,
"OnTariffChange": false,
"OnBookingChange": false,
"OnPurchases": false,
"OnVisitorRegistration": false,
"OnPlaformInvoices": false,
"ReceiveCommunityDigest": false,
"ReceiveEveryMessage": false,
"OnAccessControlErrors": false,
"NextHelpDeskMessageReminder": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "1debdbff-6b73-4c85-8631-12a637fb1967",
"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 Users by IDs
Gets one or more user records based on their Id.GET https://spaces.nexudus.com/api/sys/users?User_Id=[:id1,:id2,...]
π Requires role "User-List"
Querystring parameters |
User_Id: array requried
?User_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/sys/users?User_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"FullName": "Full Name",
"Email": "email@email.com",
"AccessToken": "hush",
"PreferredLanguage": ,
"NewPassword": "password",
"PassportNumber": "Abc123456",
"PassportCardNumber": "Abc123456",
"EnablePassportAccess": false,
"Active": false,
"IsAdmin": false,
"APIAccess": false,
"Validated": false,
"MustResetPassword": false,
"LastAccess": ,
"Devices": "Devices",
"OnNewEmail": false,
"OnHelpDeskMsg": false,
"OnNewWallPost": false,
"OnNewMember": false,
"OnProfileChanges": false,
"OnNewBlogComment": false,
"OnNewEventComment": false,
"OnTariffChange": false,
"OnBookingChange": false,
"OnPurchases": false,
"OnVisitorRegistration": false,
"OnPlaformInvoices": false,
"ReceiveCommunityDigest": false,
"ReceiveEveryMessage": false,
"OnAccessControlErrors": false,
"NextHelpDeskMessageReminder": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "ee222376-be0b-4da9-8e25-a3de4ba07d7e",
"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 User by Id
Gets one user record by its Id.GET https://spaces.nexudus.com/api/sys/users/:Id
π Requires role "User-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/sys/users/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"AccessToken": "hush",
"Active": false,
"APIAccess": false,
"Devices": "Devices",
"Email": "email@email.com",
"EnablePassportAccess": false,
"FullName": "Full Name",
"IsAdmin": false,
"LastAccess": ,
"MustResetPassword": false,
"NewPassword": "password",
"NextHelpDeskMessageReminder": ,
"OnAccessControlErrors": false,
"OnBookingChange": false,
"OnHelpDeskMsg": false,
"OnNewBlogComment": false,
"OnNewEmail": false,
"OnNewEventComment": false,
"OnNewMember": false,
"OnNewWallPost": false,
"OnPlaformInvoices": false,
"OnProfileChanges": false,
"OnPurchases": false,
"OnTariffChange": false,
"OnVisitorRegistration": false,
"PassportCardNumber": "Abc123456",
"PassportNumber": "Abc123456",
"PreferredLanguageId": 12345678,
"ReceiveCommunityDigest": false,
"ReceiveEveryMessage": false,
"Validated": false,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "8bf1f850-f461-421c-858f-adb94b88bd7e",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new User
Creates a new user.POST https://spaces.nexudus.com/api/sys/users
π Requires role "User-Create"
Body parameters |
FullName: string required |
Email: string required |
AccessToken: string optional |
PreferredLanguageId: number optional |
Active: bool optional |
IsAdmin: bool optional |
APIAccess: bool optional |
Validated: bool optional |
MustResetPassword: bool optional |
LastAccess: DateTime? optional |
Devices: string optional |
OnNewEmail: bool optional |
OnHelpDeskMsg: bool optional |
OnNewWallPost: bool optional |
OnNewMember: bool optional |
OnProfileChanges: bool optional |
OnNewBlogComment: bool optional |
OnNewEventComment: bool optional |
OnTariffChange: bool optional |
OnBookingChange: bool optional |
OnPurchases: bool optional |
OnVisitorRegistration: bool optional |
OnPlaformInvoices: bool optional |
ReceiveCommunityDigest: bool optional |
ReceiveEveryMessage: bool optional |
OnAccessControlErrors: bool optional |
NextHelpDeskMessageReminder: DateTime? optional |
Example request
POST https://spaces.nexudus.com/api/sys/users Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"FullName": "Full Name",
"Email": "email@email.com",
"AccessToken": "hush",
"PreferredLanguageId": 12345678,
"Active": false,
"IsAdmin": false,
"APIAccess": false,
"Validated": false,
"MustResetPassword": false,
"LastAccess": ,
"Devices": "Devices",
"OnNewEmail": false,
"OnHelpDeskMsg": false,
"OnNewWallPost": false,
"OnNewMember": false,
"OnProfileChanges": false,
"OnNewBlogComment": false,
"OnNewEventComment": false,
"OnTariffChange": false,
"OnBookingChange": false,
"OnPurchases": false,
"OnVisitorRegistration": false,
"OnPlaformInvoices": false,
"ReceiveCommunityDigest": false,
"ReceiveEveryMessage": false,
"Businesses": [12345678, 87654321],
"UserRoles": [12345678, 87654321],
"OnAccessControlErrors": false,
"NextHelpDeskMessageReminder": ,
}
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 User
Updates an existing user.PUT https://spaces.nexudus.com/api/sys/users
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "User-Edit"
Body parameters |
Id: number required
The unique Id of the user to update. |
FullName: string cleared if missing |
Email: string cleared if missing |
AccessToken: string cleared if missing |
PreferredLanguageId: number cleared if missing |
NewPassword: string cleared if missing |
Active: bool cleared if missing |
IsAdmin: bool cleared if missing |
APIAccess: bool cleared if missing |
Validated: bool cleared if missing |
MustResetPassword: bool cleared if missing |
LastAccess: DateTime? cleared if missing |
Devices: string cleared if missing |
OnNewEmail: bool cleared if missing |
OnHelpDeskMsg: bool cleared if missing |
OnNewWallPost: bool cleared if missing |
OnNewMember: bool cleared if missing |
OnProfileChanges: bool cleared if missing |
OnNewBlogComment: bool cleared if missing |
OnNewEventComment: bool cleared if missing |
OnTariffChange: bool cleared if missing |
OnBookingChange: bool cleared if missing |
OnPurchases: bool cleared if missing |
OnVisitorRegistration: bool cleared if missing |
OnPlaformInvoices: bool cleared if missing |
ReceiveCommunityDigest: bool cleared if missing |
ReceiveEveryMessage: bool cleared if missing |
OnAccessControlErrors: bool cleared if missing |
NextHelpDeskMessageReminder: DateTime? cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/sys/users Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"FullName": "Full Name",
"Email": "email@email.com",
"AccessToken": "hush",
"PreferredLanguageId": 12345678,
"Active": false,
"IsAdmin": false,
"APIAccess": false,
"Validated": false,
"MustResetPassword": false,
"LastAccess": ,
"Devices": "Devices",
"OnNewEmail": false,
"OnHelpDeskMsg": false,
"OnNewWallPost": false,
"OnNewMember": false,
"OnProfileChanges": false,
"OnNewBlogComment": false,
"OnNewEventComment": false,
"OnTariffChange": false,
"OnBookingChange": false,
"OnPurchases": false,
"OnVisitorRegistration": false,
"OnPlaformInvoices": false,
"ReceiveCommunityDigest": false,
"ReceiveEveryMessage": false,
"Businesses": [12345678, 87654321],
"UserRoles": [12345678, 87654321],
"OnAccessControlErrors": false,
"NextHelpDeskMessageReminder": ,
}
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 User
Deletes an existing user by its Id.DELETE https://spaces.nexudus.com/api/sys/users/:Id
π Requires role "User-Delete"
URL parameters |
Id: number required
The unique Id of the user to update. |
Example request
DELETE https://spaces.nexudus.com/api/sys/users/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 user 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 user records.GET https://spaces.nexudus.com/api/sys/users/commands
Example request
GET https://spaces.nexudus.com/api/sys/users/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 user record IDs.POST https://spaces.nexudus.com/api/sys/users/runacommandπ Requires role "User-Edit"
Example request
POST https://spaces.nexudus.com/api/sys/users/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
}
Enumerated values
Language
GET /api/utils/enums?name=eLanguage
Binary files
The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.
Avatar
GET https://spaces.nexudus.com/api/sys/users/getavatar/:id
URL parameters |
Id: number required
The id of the User to get the avatar for. |
Comments
Please sign in to leave a comment.