Feature Access Code

Feature Access Codes allows you configure the feature access codes for the Tenant.

Retrieve List of FACS

GET /api/v1/tenants/(string: tenant_id)/properties/facs/

Get the list of feature access codes for a Tenant.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/properties/facs/ HTTP/1.1
Host: example.com

Example response:

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

{"featureAccessCodes": [
      {"name": "Call Forwarding No Answer Interrogation", "enabled": true, "code": "*61*"},
      {"name": "Night Service Activation Manual Override", "enabled": true, "code": "#70"},
      {"name": "Voice Mail Clear MWI", "enabled": true, "code": "*99","alternateCode": "##4"},
      ......
      {"name": "Number Portability Announcement Activation", "enabled": True, "code": "*84"}
  ]
}
Response JSON Object:

  • featureAccessCodes (array) – The list of Feature Access Codes. Each item in the array contains a FAC. See Feature Access Code

Status Codes:

Update Feature Access Codes

PUT /api/v1/tenants/(string: tenant_id)/properties/facs/

Modify a list of feature access codes for a Tenant.

Authorization Right: Minimum Tenant Admin.

Example request:

PUT /api/v1/tenants/foo/properties/facs/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "featureAccessCodes": [
      {"name": "Call Forwarding No Answer Interrogation", "enabled": true, "code": "*61*", "alternateCode": ""}
  ]
}
Request JSON Object:

  • featureAccessCodes (array) – The list of Feature Access Codes to be updated. Each item in the array contains a FAC. See Feature Access Code.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    failed to update. Among others these specific errors could occur:

    • 2: INVALID_PARAMETERS, “You assigned the same access code to two services.”. va lid for both the code and the alternateCode.

    • 19: NOT_AVAILABLE_FOR_ASSIGNMENT, “Requested Service is not available.”, in case the FAC refers to a service not authorized for this Tenant.