Advice of Charge Service¶
Display user’s advice of charge¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/aoc/
¶ Retrieve the settings of the Advice of Charge service of the user.
Example request:
GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/aoc/ HTTP/1.1 Host: example.com
Example response:
HTTP/1.1 200 OK Content-Type: "application/json" { "active": true "type": "End" }
- Response JSON Object:
active (boolean) – the status of the service.
type (string) – One of the 2 values “End” or “During”.
- Status Codes:
200 OK – no error
404 Not Found – the service is not assigned to the user
Update a user’s do not disturb¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/aoc/
¶ Update the settings of the Advice of Charge service of the user.
Example request:
PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/aoc/ HTTP/1.1 Host: example.com Content-Type: "application/json" { "active": true "type": "During" }
- Request JSON Object:
active (boolean) – the status of the service.
type (string) – One of the 2 values “End” or “During”.
Example response:
- Response:
Similar to GET instance method response.
- Status Codes:
200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update