Api >

Service Portal REST API

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

GET returns Group Services
Given I am authenticated as Customer K0002
And there is a Group Service with
  • service number 345
  • extension number 789
  • display name group service
When I send /api/customers/K0002/targets/group-services
Then I should receive HTTP/1.1 200 OK 
{
  "href": "/api/customers/K0002/targets/group-services?_offset=0&_pagesize=16&_orderBy=serviceNumber&_order=ASC",
  "offset": 0,
  "total": 1,
  "size": 1,
  "links": [{
    "rel": "availableTimeoutDestinations",
    "href": "/api/customers/K0002/targets/group-services/available-destinations-on-timeout"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/group-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "group service"
    }, {
      "name": "displayName",
      "value": "group service"
    }, {
      "name": "extensionNumber",
      "value": "789"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*750345"
    }]
  }]
}
GET returns list of Group Services ordered by extensionNumber ascending
Given I am authenticated as Customer K0002
And there is a Group Service with
  • service number 345
  • extension number 789
  • display name group service
and there is a second Group Service with
  • service number 999
  • extension number 888
  • display name another group service
When I send /api/customers/K0002/targets/group-services?_orderBy=extensionNumber&_order=asc
Then I should receive HTTP/1.1 200 OK 
{
  "href": "/api/customers/K0002/targets/group-services?_offset=0&_pagesize=16&_orderBy=extensionNumber&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableTimeoutDestinations",
    "href": "/api/customers/K0002/targets/group-services/available-destinations-on-timeout"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/group-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "group service"
    }, {
      "name": "displayName",
      "value": "group service"
    }, {
      "name": "extensionNumber",
      "value": "789"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*750345"
    }]
  }, {
    "href": "/api/customers/K0002/targets/group-services/999",
    "links": [],
    "data": [{
      "name": "name",
      "value": "another group service"
    }, {
      "name": "displayName",
      "value": "another group service"
    }, {
      "name": "extensionNumber",
      "value": "888"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 999
    }, {
      "name": "serviceCode",
      "value": "*750999"
    }]
  }]
}
GET returns list of Group Services ordered by extensionNumber descending
Given I am authenticated as Customer K0002
And there is a Group Service with
  • service number 345
  • extension number 789
  • display name group service
and there is a second Group Service with
  • service number 999
  • extension number 888
  • display name another group service
When I send /api/customers/K0002/targets/group-services?_orderBy=extensionNumber&_order=desc
Then I should receive HTTP/1.1 200 OK 
{
  "href": "/api/customers/K0002/targets/group-services?_offset=0&_pagesize=16&_orderBy=extensionNumber&_order=DESC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableTimeoutDestinations",
    "href": "/api/customers/K0002/targets/group-services/available-destinations-on-timeout"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/group-services/999",
    "links": [],
    "data": [{
      "name": "name",
      "value": "another group service"
    }, {
      "name": "displayName",
      "value": "another group service"
    }, {
      "name": "extensionNumber",
      "value": "888"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 999
    }, {
      "name": "serviceCode",
      "value": "*750999"
    }]
  }, {
    "href": "/api/customers/K0002/targets/group-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "group service"
    }, {
      "name": "displayName",
      "value": "group service"
    }, {
      "name": "extensionNumber",
      "value": "789"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*750345"
    }]
  }]
}
GET returns list of Group Services ordered by name ascending
Given I am authenticated as Customer K0002
And there is a Group Service with
  • service number 345
  • extension number 789
  • display name group service
and there is a second Group Service with
  • service number 999
  • extension number 888
  • display name another group service
When I send /api/customers/K0002/targets/group-services?_orderBy=name&_order=asc
Then I should receive HTTP/1.1 200 OK 
{
  "href": "/api/customers/K0002/targets/group-services?_offset=0&_pagesize=16&_orderBy=name&_order=ASC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableTimeoutDestinations",
    "href": "/api/customers/K0002/targets/group-services/available-destinations-on-timeout"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/group-services/999",
    "links": [],
    "data": [{
      "name": "name",
      "value": "another group service"
    }, {
      "name": "displayName",
      "value": "another group service"
    }, {
      "name": "extensionNumber",
      "value": "888"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 999
    }, {
      "name": "serviceCode",
      "value": "*750999"
    }]
  }, {
    "href": "/api/customers/K0002/targets/group-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "group service"
    }, {
      "name": "displayName",
      "value": "group service"
    }, {
      "name": "extensionNumber",
      "value": "789"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*750345"
    }]
  }]
}
GET returns list of Group Services ordered by name descending
Given I am authenticated as Customer K0002
And there is a Group Service with
  • service number 345
  • extension number 789
  • display name group service
and there is a second Group Service with
  • service number 999
  • extension number 888
  • display name another group service
When I send /api/customers/K0002/targets/group-services?_orderBy=name&_order=desc
Then I should receive HTTP/1.1 200 OK 
{
  "href": "/api/customers/K0002/targets/group-services?_offset=0&_pagesize=16&_orderBy=name&_order=DESC",
  "offset": 0,
  "total": 2,
  "size": 2,
  "links": [{
    "rel": "availableTimeoutDestinations",
    "href": "/api/customers/K0002/targets/group-services/available-destinations-on-timeout"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/group-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "group service"
    }, {
      "name": "displayName",
      "value": "group service"
    }, {
      "name": "extensionNumber",
      "value": "789"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*750345"
    }]
  }, {
    "href": "/api/customers/K0002/targets/group-services/999",
    "links": [],
    "data": [{
      "name": "name",
      "value": "another group service"
    }, {
      "name": "displayName",
      "value": "another group service"
    }, {
      "name": "extensionNumber",
      "value": "888"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 999
    }, {
      "name": "serviceCode",
      "value": "*750999"
    }]
  }]
}
GET retrieves filtered Customer's Groups
Filtering is done on fields :
  • name
  • serviceNumber
  • extensionNumber
Given I am authenticated as customer K0002
And there is a Group Service with
  • service number 345
  • extension number 789
  • display name group service 18
And there is a Group Service with
  • service number 123
  • extension number 654
  • display name another group service
When I send /api/customers/K0002/targets/group-services?_q=18
Then I should receive HTTP/1.1 200 OK
with following body: 
{
  "href": "/api/customers/K0002/targets/group-services?_offset=0&_pagesize=16&_q=18&_orderBy=serviceNumber&_order=ASC",
  "offset": 0,
  "total": 1,
  "size": 1,
  "links": [{
    "rel": "availableTimeoutDestinations",
    "href": "/api/customers/K0002/targets/group-services/available-destinations-on-timeout"
  }],
  "items": [{
    "href": "/api/customers/K0002/targets/group-services/345",
    "links": [],
    "data": [{
      "name": "name",
      "value": "group service 18"
    }, {
      "name": "displayName",
      "value": "group service 18"
    }, {
      "name": "extensionNumber",
      "value": "789"
    }, {
      "name": "type",
      "value": "GROUP"
    }, {
      "name": "serviceNumber",
      "value": 345
    }, {
      "name": "serviceCode",
      "value": "*750345"
    }]
  }]
}
Admin cannot get Group Services' links of missing Customer
Given I am authenticated as Admin
When I send /api/customers/K0404/targets/group-services Then I should receive HTTP/1.1 404 Not Found 
{
  "title": "Customer not found",
  "detail": "Customer with identifier K0404 has not been found",
  "described_by": "http://api.nfon.net/probs/customer-not-found"
}
Customer cannot get Group Services' links of another Customer
Given there is a Group Service with service number 345
and I am authenticated as Customer K0003
When I send /api/customers/K0002/targets/group-services 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 cannot access Group Services of Customer that does not belong to him
Given I am authenticated as System Integrator S0002
When I send /api/customers/K0003/targets/group-services
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 Group Services of Customer that does not belong to him
Given I am authenticated as Operator C0002
When I send /api/customers/K0003/targets/group-services
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 1272 ms on 25-Feb-2026 at 00:45:35 CET