Api >

Service Portal REST API

Update skill
Given there is a skill service
  • with name skill name
  • with service number 345
  • and asterisk extension number 576

and it has a member with extension 698 and skill level 5
and I am authenticated as customer K0002
When I try to change a skill member member /api/customers/K0002/targets/skill-services/345/members/698
as application/json; charset=UTF-8
with following body:
{
  "data": [{
    "name": "skillLevel",
    "value": 8
  }, {
    "name": "enabled",
    "value": false
  }]
}
Then I should receive HTTP/1.1 204 No Content
Given I am authenticated as customer K0002
When I ask for a changed skill member /api/customers/K0002/targets/skill-services/345/members/698
Then I should receive HTTP/1.1 200 OK
And Content-Type header should be application/vnd.collection.next+json
with following body:
{
  "href": "/api/customers/K0002/targets/skill-services/345/members/698",
  "data": [{
    "name": "skillLevel",
    "value": 8
  }, {
    "name": "enabled",
    "value": false
  }]
}
Cannot set incorrect skill level
Given there is a skill service
  • with name skill name
  • with service number 345
  • and asterisk extension number 576

and it has a member with extension 698 and skill level 5
and I am authenticated as customer K0002
When I try to change a skill member /api/customers/K0002/targets/skill-services/345/members/698
as application/json; charset=UTF-8
with following body:
{
  "data": [{
    "name": "skillLevel",
    "value": 13
  }]
}
Then I should receive HTTP/1.1 400 Bad Request
And Content-Type header should be application/api-problem+json
with following body:
{
  "title": "Validation error",
  "detail": "Could not create or update resource due to constraint violations",
  "errors": [{
    "message": "skillLevel should be between 1 and 10",
    "path": "skillLevel",
    "value": 13
  }],
  "described_by": "http://api.nfon.net/probs/validation-error"
}
Cannot change extensionDisplayName
Given there is a skill service
  • with name skill name
  • with service number 345
  • and asterisk extension number 576

and it has a member with extension 698 and skill level 5
and there is a phone extension with number 712
and I am authenticated as customer K0002
When I try to change a skill member /api/customers/K0002/targets/skill-services/345/members/698
as application/json; charset=UTF-8
with following body:
{
  "data": [{
    "name": "extensionDisplayName",
    "value": "new name"
  }]
}
Then I should receive HTTP/1.1 400 Bad Request
And Content-Type header should be application/api-problem+json
with following body:
{
  "title": "Validation error",
  "detail": "Could not create or update resource due to constraint violations",
  "errors": [{
    "message": "A readonly field is being modified with different value.",
    "path": "extensionDisplayName",
    "value": "new name"
  }],
  "described_by": "http://api.nfon.net/probs/validation-error"
}
Cannot change Phone Extension of a Skill Member
Given there is a skill service
  • with name skill name
  • with service number 345
  • and asterisk extension number 576

and it has a member with extension 698 and skill level 5
and there is a phone extension with number 712
and I am authenticated as customer K0002
When I try to change a skill member /api/customers/K0002/targets/skill-services/345/members/698
as application/json; charset=UTF-8
with following body:
{
  "links": [{
    "rel": "phoneExtension",
    "href": "/api/customers/K0002/targets/phone-extensions/712"
  }]
}
Then I should receive HTTP/1.1 400 Bad Request
And Content-Type header should be application/api-problem+json
with following body:
{
  "title": "Validation error",
  "detail": "Could not create or update resource due to constraint violations",
  "errors": [{
    "message": "A readonly field is being modified with different value.",
    "path": "phoneExtension",
    "value": "/api/customers/K0002/targets/phone-extensions/712"
  }],
  "described_by": "http://api.nfon.net/probs/validation-error"
}
Missing Skill Member
Given there is a skill service
  • with name skill name
  • with service number 345
  • and asterisk extension number 576

and it has no members
and I am authenticated as customer K0002
When I try to change a skill member that does not exist /api/customers/K0002/targets/skill-services/345/members/404
as application/json; charset=UTF-8
with following body:
{}
Then I should receive HTTP/1.1 404 Not Found
And Content-Type header should be application/api-problem+json
with following body:
{
  "title": "Skill member not found",
  "detail": "Skill member with extension number 404 not found",
  "described_by": "http://api.nfon.net/probs/skill-member-not-found"
}
Missing Skill
Given there is no skill service with 404 identifier and I am authenticated as customer K0002
When I try to change a skill member in a skill service that does not exist /api/customers/K0002/targets/skill-services/404/members/698
as application/json; charset=UTF-8
with following body:
{}
Then I should receive HTTP/1.1 404 Not Found
And Content-Type header should be application/api-problem+json
with following body:
{
  "title": "Skill service not found",
  "detail": "Skill service with serviceNumber 404 not found",
  "described_by": "http://api.nfon.net/probs/skill-service-not-found"
}
Missing Customer
Given I am authenticated as Admin
When I send /api/customers/K404/targets/skill-services/345/members/698
as application/json; charset=UTF-8
with following body:
{}
Then I should receive HTTP/1.1 404 Not Found
And Content-Type header should be application/api-problem+json
with following body:
{
  "title": "Customer not found",
  "detail": "Customer with identifier K404 has not been found",
  "described_by": "http://api.nfon.net/probs/customer-not-found"
}
Customer should not be able to update skill member with Phone Extension of another Customer
Given I am authenticated as customer K0002
When I try to add member with extension that belongs to another customer /api/customers/K0003/targets/skill-services/345/members/123
as application/json; charset=UTF-8
with following body:
{
  "links": [{
    "rel": "phoneExtension",
    "href": "/api/customers/K0002/targets/phone-extensions/712"
  }]
}
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 [K0003]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
System Integrator cannot update Skill Service Member of Customer that does not belong to him
Given I am authenticated as System Integrator S0002
When I send /api/customers/K0003/targets/skill-services/345/members/123
as application/json; charset=UTF-8
with following body:
{
  "links": [{
    "rel": "phoneExtension",
    "href": "/api/customers/K0003/targets/phone-extensions/712"
  }]
}
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 Skill Service Member of Customer that does not belong to him
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/targets/skill-services/345/members/123
as application/json; charset=UTF-8
with following body:
{
  "links": [{
    "rel": "phoneExtension",
    "href": "/api/customers/K0003/targets/phone-extensions/712"
  }]
}
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"
}