Api >

Service Portal REST API

GET /api/customers/{customer-id}/targets/routing-prefix

GET retrieves all details of Customer's Routing Prefix Extensions
Given I am authenticated as customer K0002
and there is a Routing Prefix Extension with
  • extension number 17
  • and display name Routing Prefix Extension
When I send /api/customers/K0002/targets/routing-prefix
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/routing-prefix?_offset=0&_pagesize=16&_orderBy=extensionNumber&_order=ASC",
  "offset": 0,
  "total": 1,
  "size": 1,
  "links": [{
    "rel": "availableDevices",
    "href": "/api/customers/K0002/targets/routing-prefix/available-devices"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/routing-prefix/17",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Routing Prefix Extension"
    }, {
      "name": "displayName",
      "value": "Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "17"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }]
}
GET retrieves list of Customer's Routing Prefix Extensions ordered by extensionNumber ascending
Given I am authenticated as customer K0002
and there is a Routing Prefix Extension with
  • extension number 17
  • and display name Routing Prefix Extension
and there is a second Routing Prefix Extension with
  • extension number 99
  • and display name Another Routing Prefix Extension
When I send /api/customers/K0002/targets/routing-prefix?_orderBy=extensionNumber&_order=asc
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/routing-prefix?_offset=0&_pagesize=16&_orderBy=extensionNumber&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableDevices",
    "href": "/api/customers/K0002/targets/routing-prefix/available-devices"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/routing-prefix/17",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "17"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }, {
    "href": "/api/customers/K0002/targets/routing-prefix/99",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Another Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "99"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }]
}
GET retrieves list of Customer's Routing Prefix Extensions ordered by extensionNumber descending
Given I am authenticated as customer K0002
and there is a Routing Prefix Extension with
  • extension number 17
  • and display name Routing Prefix Extension
and there is a second Routing Prefix Extension with
  • extension number 99
  • and display name Another Routing Prefix Extension
When I send /api/customers/K0002/targets/routing-prefix?_orderBy=extensionNumber&_order=desc
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/routing-prefix?_offset=0&_pagesize=16&_orderBy=extensionNumber&_order=DESC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableDevices",
    "href": "/api/customers/K0002/targets/routing-prefix/available-devices"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/routing-prefix/99",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Another Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "99"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }, {
    "href": "/api/customers/K0002/targets/routing-prefix/17",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "17"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }]
}
GET retrieves list of Customer's Routing Prefix Extensions ordered by name ascending
Given I am authenticated as customer K0002
and there is a Routing Prefix Extension with
  • extension number 17
  • and display name Routing Prefix Extension
and there is a second Routing Prefix Extension with
  • extension number 99
  • and display name Another Routing Prefix Extension
When I send /api/customers/K0002/targets/routing-prefix?_orderBy=name&_order=asc
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/routing-prefix?_offset=0&_pagesize=16&_orderBy=name&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableDevices",
    "href": "/api/customers/K0002/targets/routing-prefix/available-devices"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/routing-prefix/99",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Another Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "99"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }, {
    "href": "/api/customers/K0002/targets/routing-prefix/17",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "17"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }]
}
GET retrieves list of Customer's Routing Prefix Extensions ordered by name descending
Given I am authenticated as customer K0002
and there is a Routing Prefix Extension with
  • extension number 17
  • and display name Routing Prefix Extension
and there is a second Routing Prefix Extension with
  • extension number 99
  • and display name Another Routing Prefix Extension
When I send /api/customers/K0002/targets/routing-prefix?_orderBy=name&_order=desc
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/routing-prefix?_offset=0&_pagesize=16&_orderBy=name&_order=DESC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableDevices",
    "href": "/api/customers/K0002/targets/routing-prefix/available-devices"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/routing-prefix/17",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "17"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }, {
    "href": "/api/customers/K0002/targets/routing-prefix/99",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Another Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "99"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }]
}
GET retrieves filtered Customer's Routing Prefix Extensions
Filtering is done on fields :
  • name
  • extensionNumber
Given I am authenticated as customer K0002
and there is a Routing Prefix Extension with
  • extension number 18
  • and display name Routing Prefix Extension
and there is a Routing Prefix Extension with
  • extension number 17
  • and display name another Routing Prefix Extension
When I send /api/customers/K0002/targets/routing-prefix?_q=18
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/routing-prefix?_offset=0&_pagesize=16&_q=18&_orderBy=extensionNumber&_order=ASC",
  "offset": 0,
  "total": 1,
  "size": 1,
  "links": [{
    "rel": "availableDevices",
    "href": "/api/customers/K0002/targets/routing-prefix/available-devices"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/routing-prefix/18",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Routing Prefix Extension"
    }, {
      "name": "displayName",
      "value": "Routing Prefix Extension"
    }, {
      "name": "extensionNumber",
      "value": "18"
    }, {
      "name": "type",
      "value": "ROUTINGPREFIX"
    }]
  }]
}
GET returns 403 if Customer tries to access another Customer's Routing Prefix Extensions
Given I am authenticated as K0003
and there is a Routing Prefix Extension with extension number 17 assigned to K0002
When I send /api/customers/K0002/targets/routing-prefix
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"
}
Missing customer
Given I am authenticated as admin
When I send /api/customers/K404/targets/routing-prefix
Then I should get HTTP/1.1 404 Not Found 
{
  "title": "Customer not found",
  "detail": "Customer with identifier K404 has not been found",
  "described_by": "http://api.nfon.net/probs/customer-not-found"
}
System Integrator cannot access Routing Prefix Extensions of Customer that does not belong to him
Given I am authenticated as System Integrator S0002
When I send /api/customers/K0003/targets/routing-prefix
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 Routing Prefix Extensions of Customer that does not belong to him
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/targets/routing-prefix
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 1134 ms on 25-Feb-2026 at 00:44:46 CET