Api >

Service Portal REST API

GET retrieves all Conference Service's Inbound Trunk Numbers
Given I am authenticated as customer K0002
and there is a IVR Service with service number 17
which has Inbound Trunk Number +48 (22) 1111-119
and which has another Inbound Trunk Number +48 (22) 1111-234
When I send /api/customers/K0002/targets/conference-services/17/inbound-trunk-numbers
Then I should receive HTTP/1.1 200 OK
with following body:
{
  "href": "/api/customers/K0002/targets/conference-services/17/inbound-trunk-numbers?_offset=0&_pagesize=16",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableTrunks",
    "href": "/api/customers/K0002/trunks"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/conference-services/17/inbound-trunk-numbers/0048.22.1111-119",
    "links": [],
    "data": [{
      "name": "trunkNumber",
      "value": "+48 (22) 1111(0-9)"
    }, {
      "name": "didNumber",
      "value": "+48 (22) 1111-119"
    }, {
      "name": "didExtension",
      "value": "119"
    }, {
      "name": "destinationExtensionNumber",
      "value": "2"
    }, {
      "name": "destinationDisplayName",
      "value": "displayName"
    }, {
      "name": "destinationType",
      "value": "CONFERENCE"
    }]
  }, {
    "href": "/api/customers/K0002/targets/conference-services/17/inbound-trunk-numbers/0048.22.1111-234",
    "links": [],
    "data": [{
      "name": "trunkNumber",
      "value": "+48 (22) 1111(0-9)"
    }, {
      "name": "didNumber",
      "value": "+48 (22) 1111-234"
    }, {
      "name": "didExtension",
      "value": "234"
    }, {
      "name": "destinationExtensionNumber",
      "value": "2"
    }, {
      "name": "destinationDisplayName",
      "value": "displayName"
    }, {
      "name": "destinationType",
      "value": "CONFERENCE"
    }]
  }]
}
GET retrieves filtered Conference Service's Inbound Trunk Numbers
Given I am authenticated as customer K0002
and there is a IVR Service with service number 17
which has Inbound Trunk Number +48 (22) 1111-119
and which has another Inbound Trunk Number +48 (22) 1111-234
and another Inbound Trunk Number +48 (22) 3444-505
When I send /api/customers/K0002/targets/conference-services/17/inbound-trunk-numbers?_q=34
Then I should receive HTTP/1.1 200 OK
with following body:
{
  "href": "/api/customers/K0002/targets/conference-services/17/inbound-trunk-numbers?_offset=0&_pagesize=16&_q=34",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableTrunks",
    "href": "/api/customers/K0002/trunks"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/conference-services/17/inbound-trunk-numbers/0048.22.1111-234",
    "links": [],
    "data": [{
      "name": "trunkNumber",
      "value": "+48 (22) 1111(0-9)"
    }, {
      "name": "didNumber",
      "value": "+48 (22) 1111-234"
    }, {
      "name": "didExtension",
      "value": "234"
    }, {
      "name": "destinationExtensionNumber",
      "value": "2"
    }, {
      "name": "destinationDisplayName",
      "value": "displayName"
    }, {
      "name": "destinationType",
      "value": "CONFERENCE"
    }]
  }, {
    "href": "/api/customers/K0002/targets/conference-services/17/inbound-trunk-numbers/0048.22.3444-505",
    "links": [],
    "data": [{
      "name": "trunkNumber",
      "value": "+48 (22) 3444(0-9)"
    }, {
      "name": "didNumber",
      "value": "+48 (22) 3444-505"
    }, {
      "name": "didExtension",
      "value": "505"
    }, {
      "name": "destinationExtensionNumber",
      "value": "2"
    }, {
      "name": "destinationDisplayName",
      "value": "displayName"
    }, {
      "name": "destinationType",
      "value": "CONFERENCE"
    }]
  }]
}
Missing Customer
Given I am authenticated as Admin
When I send /api/customers/K0404/targets/conference-services/17/inbound-trunk-numbers
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 K0404 has not been found",
  "described_by": "http://api.nfon.net/probs/customer-not-found"
}
GET returns 403 if Customer is trying to retrieve other Customer's Conference Service Inbound Trunk Numbers
Given I am authenticated as K0003
When I send /api/customers/K0002/targets/conference-services/17/inbound-trunk-numbers 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 cannot access Conference Service Inbound Trunk Numbers of Customer that does not belong to him
Given I am authenticated as System Integrator S0002
When I send /api/customers/K0003/targets/conference-services/17/inbound-trunk-numbers
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 Conference Service Inbound Trunk Numbers of Customer that does not belong to him
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/targets/conference-services/17/inbound-trunk-numbers
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"
}