Api >

Service Portal REST API

PUT updates Customer's Speed Dial entry
Given I am authenticated as customer K0002
and there is a Speed Dial with
  • id: 100
  • name: SpeedDial1
  • destination: *555#1234
  • code: 1255
When I send /api/customers/K0002/speed-dials/100
with application/json; charset=UTF-8 and following body:
{
  "data": [{
    "name": "name",
    "value": "SpeedDial-changed"
  }, {
    "name": "destination",
    "value": "*999#999"
  }, {
    "name": "code",
    "value": "99"
  }]
}
Then I should receive HTTP/1.1 204 No Content

Given I am authenticated as customer K0002
When I send /api/customers/K0002/speed-dials/100
Then I should receive HTTP/1.1 200 OK
with following body:
{
  "href": "/api/customers/K0002/speed-dials/100",
  "links": [],
  "data": [{
    "name": "destination",
    "value": "*999#999"
  }, {
    "name": "name",
    "value": "SpeedDial-changed"
  }, {
    "name": "code",
    "value": "99"
  }, {
    "name": "outwardDialOverwrite",
    "value": false
  }]
}
Cannot update Speed Dial entry if required properties are empty
Given I am authenticated as customer K0002
and there is a Speed Dial with
  • id: 100
  • name: SpeedDial1
  • destination: *555#1234
  • code: 1255
When I send /api/customers/K0002/speed-dials/100
with application/json; charset=UTF-8 and following body:
{
  "data": [{
    "name": "name",
    "value": ""
  }, {
    "name": "destination",
    "value": ""
  }, {
    "name": "code",
    "value": ""
  }]
}
Then I should receive HTTP/1.1 400 Bad Request
with following body:
{
  "detail": "Could not create or update resource due to constraint violations",
  "title": "Validation error",
  "errors": [{
    "message": "value is missing",
    "path": "name",
    "value": ""
  }],
  "described_by": "http://api.nfon.net/probs/validation-error"
}
Cannot update Speed Dial entry if name contains invalid characters
Given I am authenticated as customer K0002
and there is a Speed Dial with
  • id: 100
  • name: SpeedDial1
  • destination: *555#1234
  • code: 1255
When I send /api/customers/K0002/speed-dials/100
with application/json; charset=UTF-8 and following body:
{
  "data": [{
    "name": "name",
    "value": "invalid=name"
  }]
}
Then I should receive HTTP/1.1 400 Bad Request
with following body:
{
  "detail": "Could not create or update resource due to constraint violations",
  "title": "Validation error",
  "errors": [{
    "message": "value has invalid characters",
    "path": "name",
    "value": "invalid=name"
  }],
  "described_by": "http://api.nfon.net/probs/validation-error"
}
Cannot update Speed Dial if displayName has invalid length
Given I am authenticated as customer K0002
and there is a Speed Dial with
  • id: 100
  • name: SpeedDial1
  • destination: *555#1234
  • code: 1255
When I send /api/customers/K0002/speed-dials/100
with application/json; charset=UTF-8 and following body:
{
  "data": [{
    "name": "name",
    "value": "very long, long, long, long, long, long, long, long name"
  }]
}
Then I should receive HTTP/1.1 400 Bad Request
with following body:
{
  "detail": "Could not create or update resource due to constraint violations",
  "title": "Validation error",
  "errors": [{
    "message": "value has invalid length",
    "path": "name",
    "value": "very long, long, long, long, long, long, long, long name"
  }],
  "described_by": "http://api.nfon.net/probs/validation-error"
}
Cannot update Speed Dial entry if destination has invalid format
Given I am authenticated as customer K0002
and there is a Speed Dial with
  • id: 100
  • name: SpeedDial1
  • destination: *555#1234
  • code: 1255
When I send /api/customers/K0002/speed-dials/100
with application/json; charset=UTF-8 and following body:
{
  "data": [{
    "name": "destination",
    "value": "(66) 1234-555"
  }]
}
Then I should receive HTTP/1.1 400 Bad Request
with following body:
{
  "detail": "Could not create or update resource due to constraint violations",
  "title": "Validation error",
  "errors": [{
    "message": "must match \"^(\\*{0,2}\\d+)?(\\#\\d+)?\"",
    "path": "destination",
    "value": "(66) 1234-555"
  }],
  "described_by": "http://api.nfon.net/probs/validation-error"
}
Missing Speed Dial
Given I am authenticated as customer K0002
And there is no Speed Dial entry with ID 404 When I send /api/customers/K0002/speed-dials/404
with application/json; charset=UTF-8 and following body:
{}
Then I should receive HTTP/1.1 404 Not Found
{
  "detail": "Speed Dial with ID 404 has not been found",
  "title": "Speed Dial not found",
  "described_by": "http://api.nfon.net/probs/speed-dial-not-found"
}
Missing Customer
Given I am authenticated as Admin
When I send /api/customers/K0404/speed-dials/100
with application/json; charset=UTF-8 and following body:
{}
Then I should receive HTTP/1.1 404 Not Found
{
  "detail": "Customer with identifier K0404 has not been found",
  "title": "Customer not found",
  "described_by": "http://api.nfon.net/probs/customer-not-found"
}
Customer should not be able to change another Customer's Speed Dials
Given I am authenticated as Customer K0003
When I send /api/customers/K0002/speed-dials/100
with application/json; charset=UTF-8 and following body:
{}
Then I should receive HTTP/1.1 403 Forbidden
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0002]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
System Integrator should not be able to create Speed Dial entry of a Customer that he cannot manage
Given I am authenticated as System Integrator S0002
When I send /api/customers/K0003/speed-dials/100
with application/json; charset=UTF-8 and following body:
{}
Then I should receive HTTP/1.1 403 Forbidden
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0003]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}
Operator should not be able to create Speed Dial entries of a Customer that he cannot manage
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/speed-dials/100
with application/json; charset=UTF-8 and following body:
{}
Then I should receive HTTP/1.1 403 Forbidden
{
  "title": "Access forbidden",
  "detail": "Access denied to [Customer] with id [K0003]",
  "described_by": "http://api.nfon.net/probs/invalid-authorization"
}