Integrated Client Package

Retrieve the expected package to be assigned

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/properties/integrated_client_package/

This API will check what Service Packs are assigned to the user and will calculate (absed on APIO Service Pack objects) what package should be assigned to this user.

This is relevant mainly when the feature is shared between the AS provisioned by the APIO and an external server.

The logic is based on the field “integrated_client” of the Service Pack object (Display services pack instance) and more precisely on its sub-fields “mode”, “package” and “package_level”.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/properties/integrated_client_package/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

or

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/properties/integrated_client_package/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "mode": "webex"
}

Example response:

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

{
   "package": "premium"
}
Request JSON Object:

  • mode (string) – The mode to be be analyzed. Default is “webex”

  • not_assigned_raises_404 (booelan) – If set to true a 404 is raised in case no Service Pack of he requested mode is assigned to the user, else an empty response is returned. Default is false

Response JSON Object:

  • package (string) – The package to be assigned. Present only if a package is needed else an empty answer is returned.

Status Codes:

  • 200 OK – no error

  • 404 Not Found – with error_code NOT_FOUND_AT_NE (8) and with message “No Services Pack of the requested mode assigned.” if no Service Pack of the requested mode and not_assigned_raises_404 is true.