Api >

Service Portal REST API

PUT updates requested License
Given I am authenticated as K0002
And there is a Base Device of category Kirk with MAC ABCDEF012345
that has a license with key License Key and type License Type and id 12 and Port Type IPEI
When I send /api/customers/K0002/devices/base/ABCDEF012345/license-keys/12 as application/json; charset=UTF-8
{
  "data": [{
    "name": "licenseKey",
    "value": "New License Key"
  }, {
    "name": "licenseType",
    "value": "New License Type"
  }]
}
Then I should receive HTTP/1.1 204 No Content
And the license with id 12 should have:
PUT does not update requested License if licenseKey is empty
Given I am authenticated as K0002
And there is a Base Device of category Kirk with MAC ABCDEF012345
that has a license with key License Key and type License Type and id 12 and Port Type IPEI
When I send /api/customers/K0002/devices/base/ABCDEF012345/license-keys/12 as application/json; charset=UTF-8
{
  "data": [{
    "name": "licenseKey",
    "value": ""
  }]
}
Then I should receive HTTP/1.1 400 Bad Request
{
  "errors": [{
    "message": "License Key has to be provided",
    "path": "licenseKey"
  }]
}
And the license with id 12 should have:
Cannot update Licence for missing Customer
Given I am authenticated as Admin
When I send /api/customers/K0404/devices/base/ABCDEF012345/license-keys/12 as application/json; charset=UTF-8
{
  "data": [{
    "name": "licenseKey",
    "value": "New License Key"
  }, {
    "name": "licenseType",
    "value": "New License Type"
  }]
}
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"
}
PUT 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/license-keys/12 as application/json; charset=UTF-8
{
  "data": [{
    "name": "licenseKey",
    "value": "New License Key"
  }, {
    "name": "licenseType",
    "value": "New License Type"
  }]
}
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"
}
Modifying License for another Customer is forbidden
Given I am authenticated as customer K0003
and there is a Base Device of category Kirk with MAC ABCDEF012345
that has a license with key License Key and type License Type and id 12 and Port Type IPEI
When I send /api/customers/K0002/devices/base/ABCDEF012345/license-keys/12 as application/json; charset=UTF-8
{
  "data": [{
    "name": "licenseKey",
    "value": "New License Key"
  }, {
    "name": "licenseType",
    "value": "New License Type"
  }]
}
Then I should receive HTTP/1.1 403 Forbidden
And Content-Type header should be application/api-problem+json
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 cannot update Licence 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/license-keys/12 as application/json; charset=UTF-8
{
  "data": [{
    "name": "licenseKey",
    "value": "New License Key"
  }, {
    "name": "licenseType",
    "value": "New License Type"
  }]
}
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 update Licence of Customer that does not belong to him
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/devices/base/ABCDEF012345/license-keys/12 as application/json; charset=UTF-8
{
  "data": [{
    "name": "licenseKey",
    "value": "New License Key"
  }, {
    "name": "licenseType",
    "value": "New License Type"
  }]
}
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"
}