NOTE: After authenticating, all APIs require a Tenant ID.
Find your Tenant ID by logging-in to https://ruckus.cloud - your Tenant ID is the 32 character string in the URL after "https://ruckus.cloud/api/ui/t/"
Returns an authentication cookie and token.
Use the token to manually set a cookie if your client does not automatically support them.
Credentials
username | string |
password | string |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Locked
Internal Server Error
{- "username": "string",
- "password": "string"
}
{- "API-KEY": "string"
}
Most RUCKUS Cloud modification APIs are asynchronous. This will be indicated by a successful HTTP response status code of 202 "Accepted". In these cases, call the Request APIs to retrieve your asynchronous-request status: if it is still pending, or it succeeded, or failed.
Get transaction request details
tenantId required | string Tenant ID |
requestId required | string Request ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "admin": "string",
- "count": 0,
- "entityId": "string",
- "method": "string",
- "requestId": "string",
- "serviceName": "string",
- "status": "PENDING",
- "tenantId": "string",
- "timestamp": "2020-06-16T08:20:21Z"
}
Get transaction requests by status
tenantId required | string Tenant ID |
status required | string Enum: "PENDING" "SUCCESS" "FAIL" Status |
page | string Page number |
size | string Page size |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
[- {
- "admin": "string",
- "count": 0,
- "entityId": "string",
- "method": "string",
- "requestId": "string",
- "serviceName": "string",
- "status": "PENDING",
- "tenantId": "string",
- "timestamp": "2020-06-16T08:20:21Z"
}
]
all
) tenantId required | string Tenant ID |
deep | boolean Set to "true" to include sub-entities in the response |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "admins": [
- {
- "adminRoles": [
- {
- "createdDate": "2020-06-16T08:20:21Z",
- "delegated": "string",
- "id": "string",
- "role": "PRIME_ADMIN",
- "updatedDate": "2020-06-16T08:20:21Z"
}
], - "createdDate": "2020-06-16T08:20:21Z",
- "dateFormat": "mm/dd/yyyy",
- "detailLevel": "ba",
- "externalId": "string",
- "id": "string",
- "updatedDate": "2020-06-16T08:20:21Z",
- "username": "string"
}
], - "createdDate": "2020-06-16T08:20:21Z",
- "delegationsTo": [
- {
- "createdDate": "2020-06-16T08:20:21Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2020-06-16T08:20:21Z",
- "id": "string",
- "isValid": true,
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2020-06-16T08:20:21Z"
}
], - "externalId": "string",
- "externalModifiedDate": "2020-06-16T08:20:21Z",
- "id": "string",
- "maintenanceDate": "2020-06-16T08:20:21Z",
- "maintenanceState": true,
- "msp": {
- "changePasswordUrl": "string",
- "contactSupportUrl": "string",
- "contractSupportBehavior": "string",
- "email": "string",
- "isDisableNotification": true,
- "logoUUID": "string",
- "mspFQDN": "string",
- "mspLabel": "string",
- "myOpenCaseBehavior": "string",
- "myOpenCaseUrl": "string",
- "openCaseBehavior": "string",
- "openCaseUrl": "string",
- "phone": "string",
- "website": "string"
}, - "mspEc": {
- "parentMspId": "string",
- "serviceEffectiveDate": "2020-06-16T08:20:21Z",
- "serviceExpirationDate": "2020-06-16T08:20:21Z"
}, - "name": "string",
- "notificationRecipients": [
- {
- "createdDate": "2020-06-16T08:20:21Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2020-06-16T08:20:21Z",
- "destination": "string",
- "id": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
], - "id": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
], - "ruckusUser": true,
- "status": "active",
- "updatedDate": "2020-06-16T08:20:21Z"
}
tenantId required | string Tenant ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "address": "string",
- "city": "string",
- "country": "string",
- "organization": "string",
- "stateOrProvince": "string",
- "zip": "string"
}
tenantId required | string Tenant ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
[- {
- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "createdDate": "2020-06-16T08:20:21Z",
- "description": "string",
- "floorPlans": [
- {
- "createdDate": "2020-06-16T08:20:21Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
], - "id": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
]
tenantId required | string Tenant ID |
Venue
address | object (Address) |
description | string The venue description |
name | string [ 2 .. 32 ] characters |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", CFGC-10000: "Internal Server Error", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error", LTE-10000: "Internal Server Error"]
{- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "description": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "createdDate": "2020-06-16T08:20:21Z",
- "description": "string",
- "floorPlans": [
- {
- "createdDate": "2020-06-16T08:20:21Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
], - "id": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
}
tenantId required | string Tenant ID |
List of Venue IDs
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", CFGC-10000: "Internal Server Error", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error", LTE-10000: "Internal Server Error"]
[- "string"
]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "createdDate": "2020-06-16T08:20:21Z",
- "description": "string",
- "floorPlans": [
- {
- "createdDate": "2020-06-16T08:20:21Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
], - "id": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
tenantId required | string Tenant ID |
venueId required | string Venue ID |
Venue
address | object (Address) |
description | string The venue description |
name | string [ 2 .. 32 ] characters |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", CFGC-10000: "Internal Server Error", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error", LTE-10000: "Internal Server Error"]
{- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "description": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "address": {
- "addressLine": "string",
- "city": "string",
- "country": "string",
- "latitude": 0,
- "longitude": 0,
- "notes": "string",
- "timezone": "string"
}, - "createdDate": "2020-06-16T08:20:21Z",
- "description": "string",
- "floorPlans": [
- {
- "createdDate": "2020-06-16T08:20:21Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
], - "id": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:21Z"
}
}
tenantId required | string Tenant ID |
venueId required | string Venue ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", CFGC-10000: "Internal Server Error", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error", LTE-10000: "Internal Server Error"]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
[- {
- "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "id": "string",
- "lastLogin": "string",
- "lastName": "string",
- "name": "string",
- "role": "PRIME_ADMIN"
}
]
tenantId required | string Tenant ID |
Admin
detailLevel | string Enum: "ba" "it" "su" "debug" |
string IDM username. Is required if the administrator to be added does not have a RUCKUS Support account | |
externalId | string IDM SWU ID. Is required if the administrator to be added has a RUCKUS Support account |
role required | string Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN" "SUPPORT" "DEVOPS" Role for this tenant |
OK
Accepted
Bad/malformed request [TNT-10300: "Admin already invited to different account", TNT-10302: "Admin already registered to RUCKUS Support", TNT-10303: "Admin already exists"]
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "role": "PRIME_ADMIN"
}
{- "requestId": "string",
- "response": {
- "adminRoles": [
- {
- "createdDate": "2020-06-16T08:20:22Z",
- "delegated": "string",
- "id": "string",
- "role": "PRIME_ADMIN",
- "updatedDate": "2020-06-16T08:20:22Z"
}
], - "createdDate": "2020-06-16T08:20:22Z",
- "dateFormat": "mm/dd/yyyy",
- "detailLevel": "ba",
- "externalId": "string",
- "id": "string",
- "updatedDate": "2020-06-16T08:20:22Z",
- "username": "string"
}
}
tenantId required | string Tenant ID |
Admin
detailLevel | string Enum: "ba" "it" "su" "debug" |
string IDM username. Is required if the administrator to be added does not have a RUCKUS Support account | |
externalId | string IDM SWU ID. Is required if the administrator to be added has a RUCKUS Support account |
role required | string Enum: "PRIME_ADMIN" "ADMIN" "READ_ONLY" "OFFICE_ADMIN" "SUPPORT" "DEVOPS" Role for this tenant |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "role": "PRIME_ADMIN"
}
{- "requestId": "string",
- "response": {
- "adminRoles": [
- {
- "createdDate": "2020-06-16T08:20:22Z",
- "delegated": "string",
- "id": "string",
- "role": "PRIME_ADMIN",
- "updatedDate": "2020-06-16T08:20:22Z"
}
], - "createdDate": "2020-06-16T08:20:22Z",
- "dateFormat": "mm/dd/yyyy",
- "detailLevel": "ba",
- "externalId": "string",
- "id": "string",
- "updatedDate": "2020-06-16T08:20:22Z",
- "username": "string"
}
}
tenantId required | string Tenant ID |
List of administrator IDs
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
[- "string"
]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
adminId required | string Administrator ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "id": "string",
- "lastLogin": "string",
- "lastName": "string",
- "name": "string",
- "role": "PRIME_ADMIN"
}
tenantId required | string Tenant ID |
adminId required | string Administrator ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
type | string Enum: "VAR" "SUPPORT" "MSP" "SUPPORT_EC" type |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
[- {
- "createdDate": "2020-06-16T08:20:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2020-06-16T08:20:22Z",
- "id": "string",
- "isValid": true,
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2020-06-16T08:20:22Z"
}
]
tenantId required | string Tenant ID |
Invite VAR
username | string The VAR user name |
OK
Accepted
Bad/malformed request [TNT-10304: "You cannot invite support user as a VAR",
Not-authenticated
Not-authorized
Requested Resource or Related-Entity Not Found [TNT-10301: "VAR not found in RUCKUS Support"]
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "username": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2020-06-16T08:20:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2020-06-16T08:20:22Z",
- "id": "string",
- "isValid": true,
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2020-06-16T08:20:22Z"
}
}
Allow RUCKUS Support to access your account for technical support and problem solving.
tenantId required | string Tenant ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "requestId": "string",
- "response": {
- "createdDate": "2020-06-16T08:20:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2020-06-16T08:20:22Z",
- "id": "string",
- "isValid": true,
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2020-06-16T08:20:22Z"
}
}
tenantId required | string Tenant ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
delegationId required | string Delegation ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "createdDate": "2020-06-16T08:20:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2020-06-16T08:20:22Z",
- "id": "string",
- "isValid": true,
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2020-06-16T08:20:22Z"
}
Accept or reject a delegation.
tenantId required | string Tenant ID |
delegationId required | string Delegation ID |
Accept
accept | boolean |
fromTenantId | string The Tenant ID that requested the delegation. |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "accept": true,
- "fromTenantId": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2020-06-16T08:20:22Z",
- "delegatedBy": "string",
- "delegatedTo": "string",
- "delegatedToAdmin": "string",
- "delegatedToName": "string",
- "expiryDate": "2020-06-16T08:20:22Z",
- "id": "string",
- "isValid": true,
- "status": "INVITED",
- "type": "VAR",
- "updatedDate": "2020-06-16T08:20:22Z"
}
}
tenantId required | string Tenant ID |
delegationId required | string Delegation ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
[- {
- "createdDate": "2020-06-16T08:20:22Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2020-06-16T08:20:22Z",
- "destination": "string",
- "id": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
], - "id": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
]
tenantId required | string Tenant ID |
Notification-recipient
description required | string The description of the notification recipient |
endpoints required | Array of objects (NotificationEndpoint) |
OK
Accepted
Bad/malformed request [TNT-10100: "Duplicate notification endpoint"]
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "description": "string",
- "endpoints": [
- {
- "active": true,
- "destination": "string",
- "status": "OK",
- "type": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "createdDate": "2020-06-16T08:20:22Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2020-06-16T08:20:22Z",
- "destination": "string",
- "id": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
], - "id": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
}
tenantId required | string Tenant ID |
List of notification-recipients
description required | string The description of the notification recipient |
endpoints required | Array of objects (NotificationEndpoint) |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
[- {
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "destination": "string",
- "status": "OK",
- "type": "string"
}
]
}
]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
notificationRecipientId required | string Notification-recipient ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "createdDate": "2020-06-16T08:20:22Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2020-06-16T08:20:22Z",
- "destination": "string",
- "id": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
], - "id": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
tenantId required | string Tenant ID |
notificationRecipientId required | string Notification-recipient ID |
Notification-recipient
description required | string The description of the notification recipient |
endpoints required | Array of objects (NotificationEndpoint) |
OK
Accepted
Bad/malformed request [TNT-10100: "Duplicate notification endpoint"]
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "description": "string",
- "endpoints": [
- {
- "active": true,
- "destination": "string",
- "status": "OK",
- "type": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "createdDate": "2020-06-16T08:20:22Z",
- "description": "string",
- "endpoints": [
- {
- "active": true,
- "createdDate": "2020-06-16T08:20:22Z",
- "destination": "string",
- "id": "string",
- "status": "OK",
- "type": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
], - "id": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
}
tenantId required | string Tenant ID |
notificationRecipientId required | string Notification-recipient ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "adminId": "string",
- "allowedRegions": [
- {
- "current": true,
- "description": "string",
- "link": "string",
- "name": "string"
}
], - "companyName": "string",
- "dateFormat": "mm/dd/yyyy",
- "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "firstName": "string",
- "lastName": "string",
- "roles": [
- "string"
], - "tenantId": "string",
- "username": "string",
- "var": true,
- "varTenantId": "string"
}
tenantId required | string Tenant ID |
User profile
dateFormat required | string Enum: "mm/dd/yyyy" "dd/mm/yyyy" "yyyy/mm/dd" |
detailLevel required | string Enum: "ba" "it" "su" "debug" |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [TNT-10001: "Tenant is out of sync and requires repair"]
{- "dateFormat": "mm/dd/yyyy",
- "detailLevel": "ba"
}
{- "requestId": "string",
- "response": {
- "adminId": "string",
- "allowedRegions": [
- {
- "current": true,
- "description": "string",
- "link": "string",
- "name": "string"
}
], - "companyName": "string",
- "dateFormat": "mm/dd/yyyy",
- "detailLevel": "ba",
- "email": "string",
- "externalId": "string",
- "firstName": "string",
- "lastName": "string",
- "roles": [
- "string"
], - "tenantId": "string",
- "username": "string",
- "var": true,
- "varTenantId": "string"
}
}
tenantId required | string Tenant ID |
type | string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (optional) |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
[- {
- "assignedLicense": true,
- "createdDate": "2020-06-16T08:20:22Z",
- "deviceSubType": "string",
- "deviceType": "UNASSIGNED_DEVICE_TYPE",
- "effectiveDate": "2020-06-16T08:20:22Z",
- "expirationDate": "2020-06-16T08:20:22Z",
- "externalId": "string",
- "graceEndDate": "2020-06-16T08:20:22Z",
- "historical": true,
- "id": "string",
- "quantity": 0,
- "sku": "string",
- "tempLicense": true,
- "updatedDate": "2020-06-16T08:20:22Z"
}
]
tenantId required | string Tenant ID |
type | string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (optional) |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
[- {
- "deviceCount": 0,
- "deviceSubType": "string",
- "deviceType": "UNASSIGNED_DEVICE_TYPE",
- "effectiveDate": "2020-06-16T08:20:22Z",
- "errorCode": "string",
- "expirationDate": "2020-06-16T08:20:22Z",
- "internalMessage": "string",
- "quantity": 0,
- "remainingDays": 0,
- "remainingDevices": 0,
- "sku": "string"
}
]
tenantId required | string Tenant ID |
mspEcTenantId required | string MSP End-Customer Tenant ID |
type | string Enum: "WIFI" "LTE" "SWITCH" Filter by device type (optional) |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "entitlements": [
- {
- "assignedLicense": true,
- "createdDate": "2020-06-16T08:20:22Z",
- "deviceSubType": "string",
- "deviceType": "UNASSIGNED_DEVICE_TYPE",
- "effectiveDate": "2020-06-16T08:20:22Z",
- "expirationDate": "2020-06-16T08:20:22Z",
- "externalId": "string",
- "graceEndDate": "2020-06-16T08:20:22Z",
- "historical": true,
- "id": "string",
- "quantity": 0,
- "sku": "string",
- "tempLicense": true,
- "updatedDate": "2020-06-16T08:20:22Z"
}
], - "summary": [
- {
- "deviceCount": 0,
- "deviceSubType": "string",
- "deviceType": "UNASSIGNED_DEVICE_TYPE",
- "effectiveDate": "2020-06-16T08:20:22Z",
- "errorCode": "string",
- "expirationDate": "2020-06-16T08:20:22Z",
- "internalMessage": "string",
- "quantity": 0,
- "remainingDays": 0,
- "remainingDevices": 0,
- "sku": "string"
}
]
}
Manage floor-plans and calibration-points (calibrations-points are used to establish precise LTE AP positioning)
tenantId required | string Tenant ID |
venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
[- {
- "createdDate": "2020-06-16T08:20:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
]
tenantId required | string Tenant ID |
venueId required | string Venue ID |
Floor-plan
floorNumber | integer <int32> |
imageId | string Use file upload API to obtain a file ID for this parameter |
name | string The floor plan name |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error", LTE-10000: "Internal Server Error"]
{- "floorNumber": 0,
- "imageId": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2020-06-16T08:20:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
}
tenantId required | string Tenant ID |
venueId required | string Venue ID |
floorPlanId required | string Floor-plan ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
{- "createdDate": "2020-06-16T08:20:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
tenantId required | string Tenant ID |
venueId required | string Venue ID |
floorPlanId required | string Floor-plan ID |
Floor-plan
floorNumber | integer <int32> |
imageId | string Use file upload API to obtain a file ID for this parameter |
name | string The floor plan name |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error", LTE-10000: "Internal Server Error"]
{- "floorNumber": 0,
- "imageId": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "createdDate": "2020-06-16T08:20:22Z",
- "floorNumber": 0,
- "id": "string",
- "imageId": "string",
- "imageUrl": "string",
- "name": "string",
- "updatedDate": "2020-06-16T08:20:22Z"
}
}
tenantId required | string Tenant ID |
venueId required | string Venue ID |
floorPlanId required | string Floor-plan ID |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", WIFI-10000: "Internal Server Error", SWITCH-10000: "Internal Server Error", LTE-10000: "Internal Server Error"]
{- "requestId": "string"
}
Calibrations-points are used to establish precise LTE AP positioning
floorPlanId required | string Floor-Plan ID |
tenantId required | string Tenant ID |
venueId required | string Venue ID |
OK
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error
[- {
- "id": "string",
- "latitude": "string",
- "longitude": "string",
- "xPercent": 0,
- "yPercent": 0
}
]
Calibrations-points are used to establish precise LTE AP positioning
floorPlanId required | string Floor-plan ID |
tenantId required | string Tenant ID |
venueId required | string Venue ID |
List of calibration-point
id | string |
latitude | string |
longitude | string |
xPercent | number <float> |
yPercent | number <float> |
OK
Accepted
Bad/malformed request
Not-authenticated
Not-authorized
Requested resource or related-entity not found
Validation error
Locked
Internal Server Error [VENUE-10001: "Tenant is out of sync and requires repair", LTE-10000: "Internal Server Error", VENUE-10203: "Two calibration points are required"]
[- {
- "id": "string",
- "latitude": "string",
- "longitude": "string",
- "xPercent": 0,
- "yPercent": 0
}
]
{- "requestId": "string",
- "response": [
- {
- "id": "string",
- "latitude": "string",
- "longitude": "string",
- "xPercent": 0,
- "yPercent": 0
}
]
}
Various APIs require a file ID (e.g., floor-plan image). Call this API to obtain a File ID and the URL to upload the file to.
tenantId required | string Tenant ID |
Upload details
fileExtension | string The file extension |
OK
Unauthorized
Forbidden
Not Found
{- "fileExtension": "string"
}
Various APIs return a file ID. Call this API to obtain the URL to download the file.
tenantId required | string Tenant ID |
fileId required | string File ID |
Redirection to actual location of file. Call the redirected URL without headers, otherwise the redirect will fail with a 403 error.
Unauthorized
Forbidden
Not Found