Extensions Length¶
Display group’s extensions length¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/extensions_length/
¶ Retrieve the attributes specifying the allowed lengths for the extensions of a group.
Example request:
GET /api/v1/tenants/foo/groups/foogroup/extensions_length/ HTTP/1.1 Host: example.com
Example response:
HTTP/1.1 200 OK Content-Type: "application/json" { "minLength": 2, "maxLength": 6, "defaultLength": 4 }
- Response JSON Object:
minLength (integer) – the minimum length for an extension.
maxLength (integer) – the maximum length for an extension.
defaultLength (integer) – the default length for an extension.
- Status Codes:
200 OK – no error
Modify group’s extensions length¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/extensions_length/
¶ Modify the attributes specifying the allowed lengths for the extensions of a group.
Example request:
PUT /api/v1/tenants/footenant/groups/foogroup/extensions_length/ HTTP/1.1 Host: example.com Content-Type: "application/json" { "minLength": 2, "maxLength": 6, "defaultLength": 4 }
- Request JSON Object:
minLength (integer) – (optional) the minimum length for an extension.
maxLength (integer) – (optional) the maximum length for an extension.
defaultLength (integer) – (optional) the default length for an extension.
Example response:
- Response:
Similar to GET method response.
- Status Codes:
200 OK – no error
400 Bad Request – bad request