User Main Phone’s Primary line status

A phone can be configure to manage several lines. Out of these lines one, and only one, of them can be marked as primary.

This end point is to manage the fact that the user is the primary line (or primary linePort) of his main device or not.

Retrieve the configuration

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/access_device/primary_line_port/
GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/access_device/primay_line_port/ (deprecated)

Retrieve the primary line status of the End User on his Main Device.

Authorization Right: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/access_device/primary_line_port/ HTTP/1.1
Host: example.com

Example response:

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

{
   "primaryLinePort": false
}
Response JSON Object:

  • primaryLinePort (boolean) – Is or not the primary line

Status Codes:

Update the configuration

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/access_device/primary_line_port/
PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/access_device/primay_line_port/ (deprecated)

Update the primary line status of the End User on his Main Device.

Authorization Right: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/access_device/primary_line_port/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "primaryLinePort": true
}
Request JSON Object:

  • primaryLinePort (boolean) – Is or not the primary line

Example response:

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

{
   "primaryLinePort": true
}
Response JSON Object:

  • primaryLinePort (boolean) – Is or not the primary line

Status Codes:

  • 200 OK – no error

  • 404 Not Found – the user has no phone linked to him.

  • 400 Bad Request –

    various errors due to input data or status in the AS. . Among others:

    • 2: INVALID_PARAMETERS, “This Phone Type does not supports primary line port setting”