Api >

Service Portal REST API

GET /api/customers/{customer-id}/devices/base/{baseDeviceId}

GET returns requested Kirk Base Device
Given I am authenticated as K0002
And there is a Base Device of category Kirk with MAC ABCDEF012345 and Port Type IPEI
which has been created at 2015-10-12 04:25 and with supportsAuthentication set to true
and with authorisation PIN set to 470267
When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/devices/base/ABCDEF012345",
  "links": [{
    "rel": "deviceType",
    "href": "/api/customers/K0002/device-types/Base%20Device"
  }, {
    "rel": "site",
    "href": "/api/customers/K0002/sites/1"
  }, {
    "rel": "firmware",
    "href": "/api/customers/K0002/device-types/Base%20Device/firmwares/1.0"
  }, {
    "rel": "licenseKeys",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/license-keys"
  }, {
    "rel": "handsets",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/handsets"
  }, {
    "rel": "activation",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/activate"
  }, {
    "rel": "siteOptions",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/site-options"
  }, {
    "rel": "bypassAuthentication",
    "href": "/api/customers/K0002/devices/ABCDEF012345/bypass-authentication"
  }, {
    "rel": "resetAthentication",
    "href": "/api/customers/K0002/devices/ABCDEF012345/reset-authentication"
  }],
  "data": [{
    "name": "deviceType",
    "value": "Base Device"
  }, {
    "name": "deviceId",
    "value": "ABCDEF012345"
  }, {
    "name": "uniqueIdentifier",
    "value": "ABCDEF012345"
  }, {
    "name": "extension",
    "value": ""
  }, {
    "name": "created",
    "value": "2015-10-12 04:25"
  }, {
    "name": "active",
    "value": true
  }, {
    "name": "deviceMasterCategory",
    "value": "BASE"
  }, {
    "name": "deviceCategory",
    "value": "Kirk"
  }, {
    "name": "masterCategory",
    "value": "BASE"
  }, {
    "name": "category",
    "value": "Kirk"
  }, {
    "name": "site",
    "value": "Dummy site K0002"
  }, {
    "name": "siteName",
    "value": "Dummy site K0002"
  }, {
    "name": "siteStreet",
    "value": ""
  }, {
    "name": "siteZip",
    "value": ""
  }, {
    "name": "siteCity",
    "value": ""
  }, {
    "name": "siteState",
    "value": null
  }, {
    "name": "siteCountry",
    "value": ""
  }, {
    "name": "siteSalesForceId",
    "value": "1"
  }, {
    "name": "note",
    "value": null
  }, {
    "name": "baseFamily",
    "value": "family-1"
  }, {
    "name": "uniqueIdentifier",
    "value": "ABCDEF012345"
  }, {
    "name": "mac",
    "value": "ABCDEF012345"
  }, {
    "name": "dhcpEnabled",
    "value": true
  }, {
    "name": "ipAddress",
    "value": null
  }, {
    "name": "netmask",
    "value": null
  }, {
    "name": "gateway",
    "value": null
  }, {
    "name": "dns1",
    "value": null
  }, {
    "name": "dns2",
    "value": null
  }, {
    "name": "mtu",
    "value": null
  }, {
    "name": "useSiteOptionsFromSite",
    "value": true
  }, {
    "name": "webguiHttpsonly",
    "value": false
  }, {
    "name": "suppressLineno",
    "value": "DEFAULT"
  }, {
    "name": "supportsAuthentication",
    "value": true
  }, {
    "name": "authenticationPIN",
    "value": "470267"
  }, {
    "name": "authenticationStatus",
    "value": "AuthenticationNecessaryVoice"
  }]
}
GET returns requested Base Device (non Kirk)
Given I am authenticated as K0002
And there is a Base Device of category NotAKirk with MAC ABCDEF012345 and Port Type PORT
and with authorisation PIN set to 988660
which has been created at 2015-10-12 04:25 When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/devices/base/ABCDEF012345",
  "links": [{
    "rel": "deviceType",
    "href": "/api/customers/K0002/device-types/Base%20Device"
  }, {
    "rel": "site",
    "href": "/api/customers/K0002/sites/1"
  }, {
    "rel": "firmware",
    "href": "/api/customers/K0002/device-types/Base%20Device/firmwares/1.0"
  }, {
    "rel": "freePorts",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/free-ports"
  }, {
    "rel": "handsets",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/handsets"
  }, {
    "rel": "activation",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/activate"
  }, {
    "rel": "siteOptions",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/site-options"
  }],
  "data": [{
    "name": "deviceType",
    "value": "Base Device"
  }, {
    "name": "deviceId",
    "value": "ABCDEF012345"
  }, {
    "name": "uniqueIdentifier",
    "value": "ABCDEF012345"
  }, {
    "name": "extension",
    "value": ""
  }, {
    "name": "created",
    "value": "2015-10-12 04:25"
  }, {
    "name": "active",
    "value": true
  }, {
    "name": "deviceMasterCategory",
    "value": "BASE"
  }, {
    "name": "deviceCategory",
    "value": "NotAKirk"
  }, {
    "name": "masterCategory",
    "value": "BASE"
  }, {
    "name": "category",
    "value": "NotAKirk"
  }, {
    "name": "site",
    "value": "Dummy site K0002"
  }, {
    "name": "siteName",
    "value": "Dummy site K0002"
  }, {
    "name": "siteStreet",
    "value": ""
  }, {
    "name": "siteZip",
    "value": ""
  }, {
    "name": "siteCity",
    "value": ""
  }, {
    "name": "siteState",
    "value": null
  }, {
    "name": "siteCountry",
    "value": ""
  }, {
    "name": "siteSalesForceId",
    "value": "1"
  }, {
    "name": "note",
    "value": null
  }, {
    "name": "baseFamily",
    "value": "family-1"
  }, {
    "name": "uniqueIdentifier",
    "value": "ABCDEF012345"
  }, {
    "name": "mac",
    "value": "ABCDEF012345"
  }, {
    "name": "dhcpEnabled",
    "value": true
  }, {
    "name": "ipAddress",
    "value": null
  }, {
    "name": "netmask",
    "value": null
  }, {
    "name": "gateway",
    "value": null
  }, {
    "name": "dns1",
    "value": null
  }, {
    "name": "dns2",
    "value": null
  }, {
    "name": "mtu",
    "value": null
  }, {
    "name": "useSiteOptionsFromSite",
    "value": true
  }, {
    "name": "webguiHttpsonly",
    "value": false
  }, {
    "name": "suppressLineno",
    "value": "DEFAULT"
  }, {
    "name": "supportsAuthentication",
    "value": false
  }]
}
GET returns preferred firmware for device with null firmware
Given I am authenticated as K0002
And there is a Base Type with name base
which has preferred firmware with version 01.56
And there is Standard Device with Id 123456789abc which has no firmware assigned
When I send /api/customers/K0002/devices/base/123456789abc
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/devices/base/123456789abc",
  "links": [{
    "rel": "firmware",
    "href": "/api/customers/K0002/device-types/base/firmwares/01.56"
  }]
}
GET returns requested Base Device's DHCP information
Given I am authenticated as K0002
And there is a Base Device with MAC ABCDEF012345 and following DHCP options:
  • IP Address 192.168.1.150
  • Netmask 255.255.255.0
  • Gateway 192.168.1.1
  • DNS1 8.8.8.8
  • DNS2 10.10.10.10
  • MTU 1500
When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "data": [{
    "name": "dhcpEnabled",
    "value": false
  }, {
    "name": "ipAddress",
    "value": "192.168.1.150"
  }, {
    "name": "netmask",
    "value": "255.255.255.0"
  }, {
    "name": "gateway",
    "value": "192.168.1.1"
  }, {
    "name": "dns1",
    "value": "8.8.8.8"
  }, {
    "name": "dns2",
    "value": "10.10.10.10"
  }, {
    "name": "mtu",
    "value": "1500"
  }]
}
GET returns dhcpEnabled = false when none of the Base Device's DHCP options are set
Given I am authenticated as K0002
And there is a Base Device with MAC ABCDEF012345 and no DHCP options set
When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "data": [{
    "name": "dhcpEnabled",
    "value": true
  }]
}
GET returns requested Base Device's links
Given I am authenticated as K0002
And there is a Base Device with MAC ABCDEF012345
which has 150.123 Firmware
and belongs to a062000000HbAsd Site
When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "links": [{
    "rel": "deviceType",
    "href": "/api/customers/K0002/device-types/Base%20Device"
  }, {
    "rel": "firmware",
    "href": "/api/customers/K0002/device-types/Base%20Device/firmwares/150.123"
  }, {
    "rel": "site",
    "href": "/api/customers/K0002/sites/a062000000HbAsd"
  }]
}
GET fails meaningfully if requested Base Device does not exist
Given I am authenticated as K0002
And there is no Base Device with id ABCDEF012345
When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 404 Not Found with following body: 
{
  "title": "Device not found",
  "detail": "Device with unique identifier ABCDEF012345 has not been found",
  "described_by": "http://api.nfon.net/probs/device-not-found"
}
GET returns requested Patton Base Device's bitrate
Given I am authenticated as K0002
And there is a Patton Base Device with MAC ABCDEF012345 and bitrate 12000 and Port Type IPEI
When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "data": [{
    "name": "bitrate",
    "value": "12000"
  }]
}
Customer cannot GET other Customer's Base Device
and I am authenticated as K0003
And there is a Base Device of category Kirk with MAC ABCDEF012345 and Port Type IPEI
When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 403 Forbidden with following body: 
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0002]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
System integrator can see sipUsername
Given I am authenticated as System Integrator S0002
And there is a Base Device of category Kirk with MAC ABCDEF012345 and Port Type IPEI
which has been created at 2015-10-12 04:25 When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/devices/base/ABCDEF012345",
  "links": [{
    "rel": "deviceType",
    "href": "/api/customers/K0002/device-types/Base%20Device"
  }, {
    "rel": "site",
    "href": "/api/customers/K0002/sites/1"
  }, {
    "rel": "firmware",
    "href": "/api/customers/K0002/device-types/Base%20Device/firmwares/1.0"
  }, {
    "rel": "licenseKeys",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/license-keys"
  }, {
    "rel": "handsets",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/handsets"
  }, {
    "rel": "activation",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/activate"
  }, {
    "rel": "siteOptions",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/site-options"
  }],
  "data": [{
    "name": "mac",
    "value": "ABCDEF012345"
  }, {
    "name": "dhcpEnabled",
    "value": true
  }, {
    "name": "ipAddress",
    "value": null
  }, {
    "name": "netmask",
    "value": null
  }, {
    "name": "gateway",
    "value": null
  }, {
    "name": "dns1",
    "value": null
  }, {
    "name": "dns2",
    "value": null
  }, {
    "name": "mtu",
    "value": null
  }, {
    "name": "useSiteOptionsFromSite",
    "value": true
  }, {
    "name": "webguiHttpsonly",
    "value": false
  }, {
    "name": "deviceType",
    "value": "Base Device"
  }, {
    "name": "deviceId",
    "value": "ABCDEF012345"
  }, {
    "name": "extension",
    "value": ""
  }, {
    "name": "sipUsername",
    "value": "K0002"
  }, {
    "name": "created",
    "value": "2015-10-12 04:25"
  }, {
    "name": "active",
    "value": true
  }, {
    "name": "site",
    "value": "Dummy site K0002"
  }, {
    "name": "deviceMasterCategory",
    "value": "BASE"
  }, {
    "name": "deviceCategory",
    "value": "Kirk"
  }]
}
Operator can see sipSecret
Given I am authenticated as Operator C0002
And there is a Base Device of category Kirk with MAC ABCDEF012345 and Port Type IPEI
and it has sipSecret set to kSIzxm76EE2
which has been created at 2015-10-12 04:25 When I send /api/customers/K0002/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/devices/base/ABCDEF012345",
  "links": [{
    "rel": "deviceType",
    "href": "/api/customers/K0002/device-types/Base%20Device"
  }, {
    "rel": "site",
    "href": "/api/customers/K0002/sites/1"
  }, {
    "rel": "firmware",
    "href": "/api/customers/K0002/device-types/Base%20Device/firmwares/1.0"
  }, {
    "rel": "licenseKeys",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/license-keys"
  }, {
    "rel": "handsets",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/handsets"
  }, {
    "rel": "activation",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/activate"
  }, {
    "rel": "siteOptions",
    "href": "/api/customers/K0002/devices/base/ABCDEF012345/site-options"
  }],
  "data": [{
    "name": "mac",
    "value": "ABCDEF012345"
  }, {
    "name": "dhcpEnabled",
    "value": true
  }, {
    "name": "ipAddress",
    "value": null
  }, {
    "name": "netmask",
    "value": null
  }, {
    "name": "gateway",
    "value": null
  }, {
    "name": "dns1",
    "value": null
  }, {
    "name": "dns2",
    "value": null
  }, {
    "name": "mtu",
    "value": null
  }, {
    "name": "useSiteOptionsFromSite",
    "value": true
  }, {
    "name": "webguiHttpsonly",
    "value": false
  }, {
    "name": "deviceType",
    "value": "Base Device"
  }, {
    "name": "deviceId",
    "value": "ABCDEF012345"
  }, {
    "name": "extension",
    "value": ""
  }, {
    "name": "sipUsername",
    "value": "K0002"
  }, {
    "name": "sipSecret",
    "value": "kSIzxm76EE2"
  }, {
    "name": "created",
    "value": "2015-10-12 04:25"
  }, {
    "name": "active",
    "value": true
  }, {
    "name": "site",
    "value": "Dummy site K0002"
  }, {
    "name": "deviceMasterCategory",
    "value": "BASE"
  }, {
    "name": "deviceCategory",
    "value": "Kirk"
  }]
}
Cannot read data for missing Customer
Given I am authenticated as Admin
When I send /api/customers/K0404/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 404 Not Found
with following body: 
{
  "described_by": "http://api.nfon.net/probs/customer-not-found",
  "title": "Customer not found",
  "detail": "Customer with identifier K0404 has not been found"
}
System Integrator cannot access Base Device of Customer that does not belong to him
Given I am authenticated as System Integrator S0002
When I send /api/customers/K0003/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 403 Forbidden
with following body 
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0003]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
Operator cannot access Base Device of Customer that does not belong to him
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/devices/base/ABCDEF012345
Then I should receive HTTP/1.1 403 Forbidden
with following body 
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0003]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
Results generated by Concordion
in 1915 ms on 25-Feb-2026 at 00:41:53 CET