Services Packs

Listing available services packs

GET /api/v1/configs/service_packs/

Return the list of the services packs configured.

Example request:

GET /api/v1/configs/service_packs/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{}

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "service_packs": [
      {
         "technical_name": "test-service-pack",
         "display_name": "Test Service Pack",
         "authorization": 1,
         "description": "Description of Test Service Pack",
         "no_more_assignable": false,
         "has_integrated_client": true,
         "options": [{"name': "test-sp-1"}, {"name": "test-sp-2"}]
      }
   ]
}

Request JSON Object:

• authorization (integer) – search criteria to only return the Services Packs wirth that specific value of authorization. See Services Pack Attributes in List for the allowed values.

Response JSON Object:

• service_packs (array) – the list of Services Packs. See Services Pack Attributes in List.

Status Codes:

• 200 OK – no error

Display services pack instance

GET /api/v1/configs/service_packs/(string: instance_name)/

Retrieve information about the specified services pack instance.

Example request:

GET /api/v1/configs/service_packs/test-service-pack/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "technical_name": "test-service-pack",
   "display_name": "Test Service Pack",
   "authorization": 1,
   "description": "Description of Test Service Pack",
   "no_more_assignable": false,
   "content": {},
   "integrated_client": {
      "device_types": [
        "Business Communicator - Mobile",
        "Business Communicator - PC"
      ],
      "extra_phone_ids": [
        4,
        6
      ],
      "active_statuses": [
        true,
        false
      ],
      "with_credentials": true,
      "mode": "webex",
      "package": "standard",
      "package_level" : 2
   },
   "exclusive": [],
   "options": [{"name': "test-sp-1"}, {"name": "test-sp-2"}]
   "add_data": {}
}

Response JSON Object:

• technical_name (string) – the technical name of the services pack, it’s identifier.

• display_name (string) – a friendly name of the services pack, to be displayed.

• authorization (integer) – the authorization level of the service pack, meaning if it can be used and if yes if it is an primary or optional SP. 0: Forbidden, 1: Optional, 2: Primary.

• description (string) – a description text.

• no_more_assignable (boolean) – indicate if this services pack should no more be used.

• content (object) – an object containing services containing the list of the services to be assigned.

• integrated_client (object) –

  an object containing the attributes:

  • device_types containing the list of the device types for the integrated clients.

  • extra_phone_ids containing the list of the extra phone ids for the integrated clients.

  • active_statuses containing the list of the active statuses for the integrated clients. If not defined for this service pack, true will be used.

  • with_credentials indicates if the integrated clients need to have login credentials auto-generated. If not defined for this service pack, true will be used.

  • mode containing “webex”, “btbc”, “ucone”, … (free text).

  • package the package to be assigned at Webex side.

  • package_level the level package to be assigned at Webex side. The greater the more important.

• exclusive (array) – a list containing Service packs that can not be assigned is this one is assigned.

• options (array) – the list of Service packs objects that can be assigned in option. Note that the structure is flexible and can be modified project by project. The one presented here is the currently recommended one.

• add_data (object) – an object for future use.

Status Codes:

• 200 OK – no error

• 404 Not Found – the services pack not found.

Local objects definition

Services Pack Attributes in List

Name	Type	Method	Description
		GET
technical_name	String	A	Primary identifier of the Services Pack.
display_name	String	A	User friendly display name of the Services Pack.
authorization	Integer	A	The authorization level of the service pack. 0: Forbidden, 1: Optional, 2: Primary.
description	String	A	A description of the Services Pack.
no_more_assignable	Boolean	A	Indicate if this Service Pack should no more be used.
has_integrated_client	Boolean	A	Indicate if this Service Pack has an integrated client.
options	Array	A	The list of Service packs objects that can be assigned in option. Note that the structure is flexible and can be modified project by project.