Este método permite consultar as permissões básicas de um cliente.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
GET | https://api.tomticket.com/v2.0/customer/permissions/basic | form-data |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Authorization: Bearer SEU_TOKEN_AQUICaso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.
Parâmetros da requisição
Parâmetros da requisição - Consultar Permissões de um Cliente
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
customer_id | string | Sim | 250 | Identificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de e-mail do cadastro ou o identificador interno utilizado. |
customer_type_id | string | Não | 1 | Tipo de identificador utilizado para localizar o cliente. Valores: I - Identificador interno; E - E-mail. |
JSON de saída
JSON de saída - Consultar Permissões de um Cliente
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | Informa se ocorreu um erro na operação. |
message | string | Detalhes da operação, caso tenha ocorrido ou não um problema. |
success | boolean | Retorna true caso a operação tenha sido concluída com sucesso. |
exists | boolean | Retorna true caso um cliente tenha sido encontrado. |
data | array | Lista de permissões do cliente. |
account_approved | boolean | Retorna true se o cadastro estiver aprovado. |
allowed_create_tickets | boolean | Retorna true se o cliente possuir permissão para criar chamados. Se a organização matriz dele ou a organização na qual está vinculado não possuírem essa permissão, será exibido false. |
monthly_ticket_quota | integer | Cota mensal de chamados. Caso não tenha sido definida uma cota de chamados para o cliente, é verificada a cota da organização e, caso essa também esteja vazia, o valor é buscado na organização matriz. Se o retorno for NULL, o cliente não possui uma cota de chamados e pode abrir chamados de forma ilimitada. |
email_validated | boolean | Retorna true se o endereço de e-mail estiver validado. |
Possíveis erros
| Status HTTP | Mensagem | Quando ocorre |
|---|---|---|
| 401 | Token ou valores enviados não autorizados para uso. | Quando o token ou os valores enviados não são autorizados. |
| 403 | Recurso não disponível. | Quando o recurso não está disponível. |
| 404 | Recurso não encontrado. | Quando o recurso não é encontrado. |