Get All (PBX) #

Gets all PbxConnectionProfiles for a Customer tenant.

GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs

Example #

This request will get all the PbxConnectionProfile of the given Customer tenant.

Request #

GET <https://api.na.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Authorisation: Bearer {TOKEN}

Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
	"page_size": 2,
	"data": [{
			"id": "{PBX_ID_1}",
			"name": "Pbx 1",
			"\_type": "{PBX_TYPE}",
			"tenantId": "{CUSTOMER_TENANT_ID}"
		}, {
			"id": "{PBX_ID_2}",
			"name": "Pbx 2",
			"\_type": "{PBX_TYPE}",
			"tenantId": "{CUSTOMER_TENANT_ID}"
		}
	][{
			"id": "{PBX_ID_1}",
			"name": "Pbx 1",
			"_type": "{PBX_TYPE}",
			"tenantId": "{CUSTOMER_TENANT_ID}"
		}, {
			"id": "{PBX_ID_2}",
			"name": "Pbx 2",
			"_type": "{PBX_TYPE}",
			"tenantId": "{CUSTOMER_TENANT_ID}"
		}
	],
	"status": "success",
	"timestamp": "2019-01-01T10:00:00.2890319Z"
}

Errors #

Unauthorised #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorised

Bad Request #

When the provided tenant id is not in the correct format

HTTP/1.1 400 Bad Request
Date: Thu, 06 Feb 2020 12:45:27 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 149
{
	"error":400,
	"message":"The value '<tenant id>' is not valid.",
	"status":"error",
	"timestamp":"2020-02-06T12:45:27.5903465Z"
}

Not Found #

When there are no Customers that have a matching tenant id or Users with the user Id

HTTP/1.1 404 Not Found
Date: Thu, 06 Feb 2020 12:46:58 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 95
{
	"error":404,
	"message":"Not Found",
	"status":"error",
	"timestamp":"2020-02-06T12:46:58.7669535Z"
}