GET /api/tenants/{FedmemberID}/countrycodes

Returns a list of telephone country codes for the tenant.

Authorization Roles/Permissions: No permission required.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/tenants/{FedmemberID}/countrycodes

Back to top

Sample Request

The example below shows a request for the country codes for the specified tenant.

Request URL

https://{hostname}/api/tenants/acmepaymentscorp/countrycodes

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
FedmemberID Path String Required Unique ID for a specific tenant, in a federation (multi-tenant) scenario; for example, acmepaymentscorp.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the country codes that are set up for the tenant.

Back to top

Sample Response

The sample response below shows successful completion of this operation. In this example, the tenant supports three country codes.

Sample response headers

GET http://{hostname}/api/tenants/acmepaymentscorp/countrycodes?_=1441742341105 HTTP/1.0
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
Expires: Tue, 08 Sep 2015 15:01:21 GMT

Sample response body: application/json

[
  {
    "id":"+1"
  },
  {
    "id":"+44"
  },
  {
    "id":"+91"
  }
]

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
CountryCodes CountryCodes Contains information about the telephone country codes supported on the platform.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics