The radiusserver object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this radiusserver |
AccountPort: string optional read-only |
Active: bool optional |
AuthPort: string optional read-only |
BusinessId: Id required |
CaptivePortalId: string optional read-only |
CustomerId: string optional read-only |
Description: string optional |
Name: string required |
NetworkId: string optional read-only |
RadiusIp1: string optional read-only |
RadiusIp2: string optional read-only |
SharedSecret: string optional read-only |
SplashPageId: string optional read-only |
Vendor: Nexudus.Coworking.Core.Enums.eRadiusServerVendor optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this radiusserver |
SystemId: string optional api-only
User defined data about this radiusserver. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"AccountPort": "00001",
"Active": false,
"AuthPort": "00001",
"BusinessId": 12345678,
"CaptivePortalId": "00001",
"CustomerId": "00001",
"Description": "Description",
"Name": "00001",
"NetworkId": "00001",
"RadiusIp1": "00001",
"RadiusIp2": "00001",
"SharedSecret": "00001",
"SplashPageId": "00001",
"Vendor": 1,
"UniqueId": "4802c6d3-6093-4ca4-86fb-9608acb29173",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a RadiusServer
This endpoint allows you to GET a list of radiusservers based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/sys/radiusservers?...
π Requires role "RadiusServer-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 radiusserver records based on their different properties. |
Id number
?Id=12345678 |
RadiusServer_AccountPort string
?RadiusServer_AccountPort=... |
RadiusServer_Active bool
?RadiusServer_Active=... |
RadiusServer_AuthPort string
?RadiusServer_AuthPort=... |
RadiusServer_Business Business
?RadiusServer_Business=... |
RadiusServer_CaptivePortalId string
?RadiusServer_CaptivePortalId=... |
RadiusServer_CustomerId string
?RadiusServer_CustomerId=... |
RadiusServer_Description string
?RadiusServer_Description=... |
RadiusServer_Name string
?RadiusServer_Name=... |
RadiusServer_NetworkId string
?RadiusServer_NetworkId=... |
RadiusServer_RadiusIp1 string
?RadiusServer_RadiusIp1=... |
RadiusServer_RadiusIp2 string
?RadiusServer_RadiusIp2=... |
RadiusServer_SharedSecret string
?RadiusServer_SharedSecret=... |
RadiusServer_SplashPageId string
?RadiusServer_SplashPageId=... |
RadiusServer_Vendor Nexudus.Coworking.Core.Enums.eRadiusServerVendor
?RadiusServer_Vendor=... |
Range search querystring parameters
Lets you search radiusserver records based on a range of date or numeric values. |
To_RadiusServer_CreatedOn date
?To_RadiusServer_CreatedOn=2010-01-01T20:32 |
From_RadiusServer_CreatedOn date
?From_RadiusServer_CreatedOn=2010-01-01T20:32 |
To_RadiusServer_UpdatedOn date
?To_RadiusServer_UpdatedOn=2010-01-01T20:32 |
From_RadiusServer_UpdatedOn date
?From_RadiusServer_UpdatedOn=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/sys/radiusservers?RadiusServer_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "00001",
"Vendor": 1,
"Active": false,
"Description": "Description",
"CustomerId": "00001",
"NetworkId": "00001",
"CaptivePortalId": "00001",
"SplashPageId": "00001",
"RadiusIp1": "00001",
"RadiusIp2": "00001",
"AccountPort": "00001",
"AuthPort": "00001",
"SharedSecret": "00001",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "e26d0453-3720-4bcf-8900-356c84c8381b",
"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 RadiusServers by IDs
Gets one or more radiusserver records based on their Id.GET https://spaces.nexudus.com/api/sys/radiusservers?RadiusServer_Id=[:id1,:id2,...]
π Requires role "RadiusServer-List"
Querystring parameters |
RadiusServer_Id: array requried
?RadiusServer_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/sys/radiusservers?RadiusServer_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "00001",
"Vendor": 1,
"Active": false,
"Description": "Description",
"CustomerId": "00001",
"NetworkId": "00001",
"CaptivePortalId": "00001",
"SplashPageId": "00001",
"RadiusIp1": "00001",
"RadiusIp2": "00001",
"AccountPort": "00001",
"AuthPort": "00001",
"SharedSecret": "00001",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "bb744d10-20f9-47dd-9766-2999db68cca1",
"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 RadiusServer by Id
Gets one radiusserver record by its Id.GET https://spaces.nexudus.com/api/sys/radiusservers/:Id
π Requires role "RadiusServer-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/sys/radiusservers/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"AccountPort": "00001",
"Active": false,
"AuthPort": "00001",
"BusinessId": 12345678,
"CaptivePortalId": "00001",
"CustomerId": "00001",
"Description": "Description",
"Name": "00001",
"NetworkId": "00001",
"RadiusIp1": "00001",
"RadiusIp2": "00001",
"SharedSecret": "00001",
"SplashPageId": "00001",
"Vendor": 1,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "91e65db2-758f-4b22-99d3-f34c29a80618",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new RadiusServer
Creates a new radiusserver.POST https://spaces.nexudus.com/api/sys/radiusservers
π Requires role "RadiusServer-Create"
Body parameters |
BusinessId: number required |
Name: string required |
Vendor: Nexudus.Coworking.Core.Enums.eRadiusServerVendor optional |
Active: bool optional |
Description: string optional |
Example request
POST https://spaces.nexudus.com/api/sys/radiusservers Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"Name": "00001",
"Vendor": 1, //(check Enumerated values section below)
"Active": false,
"Description": "Description",
}
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 RadiusServer
Updates an existing radiusserver.PUT https://spaces.nexudus.com/api/sys/radiusservers
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "RadiusServer-Edit"
Body parameters |
Id: number required
The unique Id of the radiusserver to update. |
BusinessId: number cleared if missing |
Name: string cleared if missing |
Vendor: Nexudus.Coworking.Core.Enums.eRadiusServerVendor cleared if missing |
Active: bool cleared if missing |
Description: string cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/sys/radiusservers Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"Name": "00001",
"Vendor": 1, //(check Enumerated values section below)
"Active": false,
"Description": "Description",
}
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 RadiusServer
Deletes an existing radiusserver by its Id.DELETE https://spaces.nexudus.com/api/sys/radiusservers/:Id
π Requires role "RadiusServer-Delete"
URL parameters |
Id: number required
The unique Id of the radiusserver to update. |
Example request
DELETE https://spaces.nexudus.com/api/sys/radiusservers/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 radiusserver 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 radiusserver records.GET https://spaces.nexudus.com/api/sys/radiusservers/commands
Example request
GET https://spaces.nexudus.com/api/sys/radiusservers/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 radiusserver record IDs.POST https://spaces.nexudus.com/api/sys/radiusservers/runacommandπ Requires role "RadiusServer-Edit"
Example request
POST https://spaces.nexudus.com/api/sys/radiusservers/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
Vendor
GET /api/utils/enums?name=eRadiusServerVendor
Comments
Please sign in to leave a comment.