Api >

Service Portal REST API

GET /api/customers/{customer-id}/targets/frontdesk-services

GET returns Customer's Frontdesk Services
Given I am authenticated as customer K0002
and there is a Frontdesk Service with:
  • displayName Frontdesk Service 1
  • extension 123
  • serviceNumber 1
  • description frontdesk agent description
  • context frontdesk agent context
  • introduction text welcome frontdesk agent
  • voice de-DE-KatjaNeural
  • fallback target reference /api/customers/K0002/targets/conference-services/1
and there is another Frontdesk Service with:
  • displayName Frontdesk Service 2
  • extension 456
  • serviceNumber 2
  • description frontdesk agent description
  • context frontdesk agent context
  • introduction text welcome frontdesk agent
  • voice de-DE-KatjaNeural
  • fallback target reference /api/customers/K0002/targets/conference-services/2
When I send /api/customers/K0002/targets/frontdesk-services
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/targets/frontdesk-services?_offset=0&_pagesize=16&_orderBy=serviceNumber&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [],
  "items": [{
    "href": "/api/customers/K0002/targets/frontdesk-services/1",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 1"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 1"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 1
    }, {
      "name": "serviceCode",
      "value": "*710001"
    }]
  }, {
    "href": "/api/customers/K0002/targets/frontdesk-services/2",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 2"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 2"
    }, {
      "name": "extensionNumber",
      "value": "456"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 2
    }, {
      "name": "serviceCode",
      "value": "*710002"
    }]
  }]
}
GET returns Customer's Frontdesk Services ordered by extensionNumber ascending
Given I am authenticated as customer K0002
and there is a Frontdesk Service:
  • displayName Frontdesk Service 1
  • extension 123
  • serviceNumber 1
and there is another Frontdesk Service with:
  • displayName Frontdesk Service 2
  • extension 456
  • serviceNumber 2
When I send /api/customers/K0002/targets/frontdesk-services?_orderBy=extensionNumber&_order=asc
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/targets/frontdesk-services?_offset=0&_pagesize=16&_orderBy=extensionNumber&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [],
  "items": [{
    "href": "/api/customers/K0002/targets/frontdesk-services/1",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 1"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 1"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 1
    }, {
      "name": "serviceCode",
      "value": "*710001"
    }]
  }, {
    "href": "/api/customers/K0002/targets/frontdesk-services/2",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 2"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 2"
    }, {
      "name": "extensionNumber",
      "value": "456"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 2
    }, {
      "name": "serviceCode",
      "value": "*710002"
    }]
  }]
}
GET returns Customer's Frontdesk Services ordered by extensionNumber descending
Given I am authenticated as customer K0002
and there is a Frontdesk Service with:
  • displayName Frontdesk Service 1
  • extension 123
  • serviceNumber 1
and there is another Frontdesk Service with:
  • displayName Frontdesk Service 2
  • extension 456
  • serviceNumber 2
When I send /api/customers/K0002/targets/frontdesk-services?_orderBy=extensionNumber&_order=desc
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/targets/frontdesk-services?_offset=0&_pagesize=16&_orderBy=extensionNumber&_order=DESC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [],
  "items": [{
    "href": "/api/customers/K0002/targets/frontdesk-services/2",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 2"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 2"
    }, {
      "name": "extensionNumber",
      "value": "456"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 2
    }, {
      "name": "serviceCode",
      "value": "*710002"
    }]
  }, {
    "href": "/api/customers/K0002/targets/frontdesk-services/1",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 1"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 1"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 1
    }, {
      "name": "serviceCode",
      "value": "*710001"
    }]
  }]
}
GET returns Customer's Frontdesk Services ordered by name ascending
Given I am authenticated as customer K0002
and there is a Frontdesk Service with:
  • displayName Frontdesk Service 1
  • extension 123
  • serviceNumber 1
and there is another Frontdesk Service with:
  • displayName Frontdesk Service 2
  • extension 456
  • serviceNumber 2
When I send /api/customers/K0002/targets/frontdesk-services?_orderBy=name&_order=asc
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/targets/frontdesk-services?_offset=0&_pagesize=16&_orderBy=name&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [],
  "items": [{
    "href": "/api/customers/K0002/targets/frontdesk-services/1",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 1"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 1"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 1
    }, {
      "name": "serviceCode",
      "value": "*710001"
    }]
  }, {
    "href": "/api/customers/K0002/targets/frontdesk-services/2",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 2"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 2"
    }, {
      "name": "extensionNumber",
      "value": "456"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 2
    }, {
      "name": "serviceCode",
      "value": "*710002"
    }]
  }]
}
GET returns Customer's Frontdesk Services ordered by name descending
Given I am authenticated as customer K0002
and there is a Frontdesk Service with:
  • displayName Frontdesk Service 1
  • extension 123
  • serviceNumber 1
and there is another Frontdesk Service with:
  • displayName Frontdesk Service 2
  • extension 456
  • serviceNumber 2
When I send /api/customers/K0002/targets/frontdesk-services?_orderBy=name&_order=desc
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/targets/frontdesk-services?_offset=0&_pagesize=16&_orderBy=name&_order=DESC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [],
  "items": [{
    "href": "/api/customers/K0002/targets/frontdesk-services/2",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 2"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 2"
    }, {
      "name": "extensionNumber",
      "value": "456"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 2
    }, {
      "name": "serviceCode",
      "value": "*710002"
    }]
  }, {
    "href": "/api/customers/K0002/targets/frontdesk-services/1",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 1"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 1"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 1
    }, {
      "name": "serviceCode",
      "value": "*710001"
    }]
  }]
}
GET returns filtered Customer's Frontdesk Services
Filtering is done on fields:
  • name
  • serviceNumber
  • extensionNumber
Given I am authenticated as customer K0002
and there is a Frontdesk Service with:
  • displayName Frontdesk Service 1
  • extension 123
  • serviceNumber 1
and there is another Frontdesk Service with:
  • displayName Frontdesk Service 2
  • extension 456
  • serviceNumber 2
When I send /api/customers/K0002/targets/frontdesk-services?_q=123
Then I should receive HTTP/1.1 200 OK with following body: 
{
  "href": "/api/customers/K0002/targets/frontdesk-services?_offset=0&_pagesize=16&_q=123&_orderBy=serviceNumber&_order=ASC",
  "offset": 0,
  "total": 1,
  "size": 1,
  "links": [],
  "items": [{
    "href": "/api/customers/K0002/targets/frontdesk-services/1",
    "links": [],
    "data": [{
      "name": "name",
      "value": "Frontdesk Service 1"
    }, {
      "name": "displayName",
      "value": "Frontdesk Service 1"
    }, {
      "name": "extensionNumber",
      "value": "123"
    }, {
      "name": "type",
      "value": "FRONTDESK"
    }, {
      "name": "serviceNumber",
      "value": 1
    }, {
      "name": "serviceCode",
      "value": "*710001"
    }]
  }]
}
Missing Customer
Given I am authenticated as Admin
When I send /api/customers/K0404/targets/frontdesk-services
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 Frontdesk Services
Given I am authenticated as K0003
and there is a Frontdesk Service with name FrontdeskService1
and another FrontDesk Service with name FrontdeskService2
When I send/api/customers/K0002/targets/frontdesk-services
Then I should receiveHTTP/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 Frontdesk Services of Customer that does not belong to him
Given I am authenticated as System Integrator S0002
When I send /api/customers/K0003/targets/frontdesk-services
Then I should receiveHTTP/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 Frontdesk Services of Customer that does not belong to him
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/targets/frontdesk-services
Then I should receiveHTTP/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 1253 ms on 25-Feb-2026 at 00:47:16 CET