Este método permite consultar as permissões básicas de um cliente.
Endpoint
https://api.tomticket.com/v2.0/customer/permissions/basic
Método HTTP
GET
Content Type
form-data
Autenticação
Authorization: Bearer {SEU-TOKEN-AQUI}
Parâmetros Query String
Os parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com o nome dele e valor, separados pelo símbolo de "=", como por exemplo nomeParametro=ValorParametro. Para enviar mais de um parâmetro, deve separá-los, usando símbolo "&", como por exemplo nomeParametro1=ValorParametro1&nomeParametro2=ValorParametro2.
| Chave | Descrição | Obrigatório | Valor Padrão | Tipo | Tamanho Máximo |
|---|---|---|---|---|---|
customer_id | Identificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de email do cadastro ou identificador interno utilizado. | Sim | - | String | 250 |
customer_type_id | Tipo de identificador utilizado para localizar o cliente, sendo:I - Identificador internoE - Email | Não | I | String | 1 |
Retorno
Descrição do retorno em JSON.
| Coluna | Descrição da Coluna | Tipo |
|---|---|---|
error | Informa se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso e não ocorreram problemas. Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo mensagem para identificar o problema. | Boolean |
message | Detalhes da operação, caso tenha ocorrido ou não um problema. | String |
success | Retorna true caso a operação tenha sido concluída com sucesso. | Boolean |
exists | Retorna true caso um cliente tenha sido encontrado. | Boolean |
| Lista de permissões do cliente. | Array |
| Retorna true se o cadastro estiver aprovado. | Boolean |
| Retorna true se o cliente possuí permissão para criar chamados. Se a organização matriz dele ou organização na qual está vinculado não possuírem essa permissão, será exibido false. | Boolean |
| Cota mensal de chamados. Caso a não tenha sido setado uma cota de chamados para o cliente, é verificado 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 possuí uma cota de chamados e pode abrir de forma ilimitada. | Int |
| Retorna true se o cadastro estiver ativo. Se a organização matriz dele ou organização na qual está vinculado estiverem inativas, será exibido false. | Boolean |
| Retorna true se o endereço de email estiver validado. | Boolean |
Código de Retorno
Descrição do código HTTP de retorno.
| Código | Descrição |
|---|---|
| 200 | Operação realizada com sucesso. |
| 401 | Token ou valores enviados não autorizados para uso. |
| 403 | Recurso não disponível. |
| 404 | Recurso não encontrado. |
Disponibilidade
