Obter tudo (PBX) #
Obtém todos os PbxConnectionProfiles para um locatário Cliente.
GET /v1.0/clientes/{CUSTOMER_TENANT_ID}/pbxs
Exemplo #
Essa solicitação obterá todo o PbxConnectionProfile do locatário do Cliente determinado.
Solicitar #
GET <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Autorização: Portador {TOKEN}
Resposta #
HTTP/1.1 200 OK
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
{
"page_size": 2,
"dados": [ {
"id": "{PBX_ID_1}",
"nome": "Pbx 1",
"\_type": "{PBX_TYPE}",
"tenantId": "{CUSTOMER_TENANT_ID}"
}, {
"id": "{PBX_ID_2}",
"nome": "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": "sucesso",
"carimbo de data/hora": "2019-01-01T10:00:00.2890319Z"
}
Erros #
Não autorizado #
Quando o token não é fornecido, inválido ou expirado
HTTP/1.1 401 Não autorizado
Mau pedido #
Quando o ID do locatário fornecido não estiver no formato correto
HTTP/1.1 400 Solicitação incorreta
Data: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de conteúdo: application/json; charset=utf-8
Comprimento do conteúdo: 149
{
"erro":400,
"message":"O valor '<tenant id>' não é válido.",
"status":"erro",
"carimbo de data/hora":"2020-02-06T12:45:27.5903465Z"
}
Não encontrado #
Quando não há Clientes que tenham um ID de locatário correspondente ou Usuários com o ID do usuário
HTTP/1.1 404 Não encontrado
Data: Thu, 06 Feb 2020 12:46:58 GMT
Tipo de conteúdo: application/json; charset=utf-8
Comprimento do conteúdo: 95
{
"erro":404,
"message":"Não encontrado",
"status":"erro",
"carimbo de data/hora":"2020-02-06T12:46:58.7669535Z"
}