Reference

Videoroom

The videoroom object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this videoroom
Active: bool optional
BusinessId: Id required
Description: string optional
Name: string required
NumberOfParticipants: int required
OnlyForContacts: bool optional
OnlyForMembers: bool optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this videoroom
SystemId: string optional api-only
User defined data about this videoroom. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "Description": "ShortText",
  "Name": "Title",
  "NumberOfParticipants": ,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "UniqueId": "23baadd1-cc5d-4450-8479-63aa29bb8f20",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a VideoRoom

This endpoint allows you to GET a list of videorooms based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/community/videorooms?...

πŸ”’ Requires role "VideoRoom-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 videoroom records based on their different properties.
Id number
?Id=12345678
VideoRoom_Active bool
?VideoRoom_Active=...
VideoRoom_Business Business
?VideoRoom_Business=...
VideoRoom_Description string
?VideoRoom_Description=...
VideoRoom_Name string
?VideoRoom_Name=...
VideoRoom_NumberOfParticipants int
?VideoRoom_NumberOfParticipants=...
VideoRoom_OnlyForContacts bool
?VideoRoom_OnlyForContacts=...
VideoRoom_OnlyForMembers bool
?VideoRoom_OnlyForMembers=...

Range search querystring parameters
Lets you search videoroom records based on a range of date or numeric values.
To_VideoRoom_CreatedOn date
?To_VideoRoom_CreatedOn=2010-01-01T20:32
From_VideoRoom_CreatedOn date
?From_VideoRoom_CreatedOn=2010-01-01T20:32
To_VideoRoom_UpdatedOn date
?To_VideoRoom_UpdatedOn=2010-01-01T20:32
From_VideoRoom_UpdatedOn date
?From_VideoRoom_UpdatedOn=2010-01-01T20:32
To_VideoRoom_NumberOfParticipants number
?To_VideoRoom_NumberOfParticipants=0
From_VideoRoom_NumberOfParticipants number
?From_VideoRoom_NumberOfParticipants=10

Example request

GET https://spaces.nexudus.com/api/community/videorooms?VideoRoom_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Title",
        "Description": "ShortText",
        "NumberOfParticipants": ,
        "Active": false,
        "OnlyForContacts": false,
        "OnlyForMembers": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "65d450a2-988d-4594-a876-fa375323cfcf",
        "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 VideoRooms by IDs

Gets one or more videoroom records based on their Id.
GET https://spaces.nexudus.com/api/community/videorooms?VideoRoom_Id=[:id1,:id2,...]

πŸ”’ Requires role "VideoRoom-List"

Querystring parameters
VideoRoom_Id: array requried
?VideoRoom_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/community/videorooms?VideoRoom_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Title",
        "Description": "ShortText",
        "NumberOfParticipants": ,
        "Active": false,
        "OnlyForContacts": false,
        "OnlyForMembers": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "95d2e9e4-dfa2-47e9-89aa-b4ba8279614f",
        "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 VideoRoom by Id

Gets one videoroom record by its Id.
GET https://spaces.nexudus.com/api/community/videorooms/:Id

πŸ”’ Requires role "VideoRoom-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/community/videorooms/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "Description": "ShortText",
  "Name": "Title",
  "NumberOfParticipants": ,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "577ed8fb-c3d2-4b1b-97e0-3042f23b3f05",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new VideoRoom

Creates a new videoroom.
POST https://spaces.nexudus.com/api/community/videorooms

πŸ”’ Requires role "VideoRoom-Create"

Body parameters
BusinessId: number required
Name: string required
Description: string optional
NumberOfParticipants: int required
Active: bool optional
OnlyForContacts: bool optional
OnlyForMembers: bool optional

Example request

POST https://spaces.nexudus.com/api/community/videorooms
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "Name": "Title",
    "Description": "ShortText",
    "NumberOfParticipants": ,
    "Active": false,
    "OnlyForContacts": false,
    "OnlyForMembers": 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 VideoRoom

Updates an existing videoroom.
PUT https://spaces.nexudus.com/api/community/videorooms

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "VideoRoom-Edit"

Body parameters
Id: number required
The unique Id of the videoroom to update.
BusinessId: number cleared if missing
Name: string cleared if missing
Description: string cleared if missing
NumberOfParticipants: int cleared if missing
Active: bool cleared if missing
OnlyForContacts: bool cleared if missing
OnlyForMembers: bool cleared if missing

Example request

PUT https://spaces.nexudus.com/api/community/videorooms
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Title",
    "Description": "ShortText",
    "NumberOfParticipants": ,
    "Active": false,
    "OnlyForContacts": false,
    "OnlyForMembers": 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 VideoRoom

Deletes an existing videoroom by its Id.
DELETE https://spaces.nexudus.com/api/community/videorooms/:Id

πŸ”’ Requires role "VideoRoom-Delete"

URL parameters
Id: number required
The unique Id of the videoroom to update.

Example request

DELETE https://spaces.nexudus.com/api/community/videorooms/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 videoroom 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 videoroom records.
GET https://spaces.nexudus.com/api/community/videorooms/commands

Example request

GET https://spaces.nexudus.com/api/community/videorooms/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 videoroom record IDs.
POST https://spaces.nexudus.com/api/community/videorooms/runacommand
πŸ”’ Requires role "VideoRoom-Edit"

Example request

POST https://spaces.nexudus.com/api/community/videorooms/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
}


Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

Image

GET https://spaces.nexudus.com/api/community/videorooms/getimage/:id
URL parameters
Id: number required
The id of the VideoRoom to get the image for.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.