Este método permite listar todos os departamentos de sua conta.
Endpoint
https://api.tomticket.com/v2.0/department/list
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 |
|---|---|---|---|---|---|
| show_nested_items | Se enviado o paramento com valor igual a zero(0) show_nested_items=0 retorna a listagem apenas com o nome dos departamentos e seus ID's, sem nenhum item aninhado, como categorias, status, atendentes, etc. | Não | 1 | Int | 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 |
| size | Total de itens encontrados. | Int |
| data | Lista com os departamentos cadastrados. | Array |
| dataid | Identificador do departamento. | String |
| dataname | Nome do departamento. | String |
| datacategories | Lista as categorias ativos vinculados ao departamento. | Array |
| datacategories id | Identificador da categoria. | String |
| datacategories name | Nome da categoria. | String |
| datacategories custom_fields | Lista de campos personalizados usados em chamados. | Array |
| datacategories custom_fields id | Identificador do campo personalizado. | String |
| datacategories custom_fields label | Label do campo personalizado. | String |
| datacategories custom_fields type | Informa o tipo do campo. Opções Disponíveis:
| Int |
| datacategories custom_fields options | Valores disponíveis do campo personalizado. | Array |
| datacategories custom_fields mandatory | Informa se o preenchimento do campo é obrigatório. | Boolean |
| datacategories custom_fields operation | Lista os tipos de operação em que este campo pode ser utilizado. | Array |
| datacategories custom_fields operation open | Informa se o campo pode ser usado para a abertura de chamados. | Boolean |
| datacategories custom_fields operation close | Informa se o campo pode ser usado para o encerramento de chamados. | Boolean |
| datacategories custom_fields operation evaluation | Informa se o campo pode ser usado para a avaliação de chamados. | Boolean |
| datastatus | Lista os status vinculados ao departamento. | Array |
| datastatus id | Identificador do status. | String |
| datastatus name | Nome do status. | String |
| datastatus active | Informa se o status está ativo para uso. | Boolean |
| dataoperators | Lista os atendentes ativos vinculados ao departamento. | Array |
| dataoperators id | Identificador do atendente. | String |
| dataoperators name | Nome do atendente. | String |
| dataoperators mail_hash | Hash MD5 do endereço de email do atendente. | String |
| datacategories | Lista as categorias ativos vinculados ao departamento. | Array |
| datacategories id | Identificador da categoria. | String |
| datacategories name | Nome da categoria. | String |
| datacategories custom_fields | Lista de campos personalizados usados em chamados. | Array |
| datacategories custom_fields id | Identificador do campo personalizado. | String |
| datacategories custom_fields label | Label do campo personalizado. | String |
| datacategories custom_fields type | Informa o tipo do campo. Opções Disponíveis:
| Int |
| datacategories custom_fields options | Valores disponíveis do campo personalizado. | Array |
| datacategories custom_fields mandatory | Informa se o preenchimento do campo é obrigatório. | Boolean |
| datacategories custom_fields operation | Lista os tipos de operação em que este campo pode ser utilizado. | Array |
| datacategories custom_fields operation open | Informa se o campo pode ser usado para a abertura de chamados. | Boolean |
| datacategories custom_fields operation close | Informa se o campo pode ser usado para o encerramento de chamados. | Boolean |
| datacategories custom_fields operation evaluation | Informa se o campo pode ser usado para a avaliação de chamados. | Boolean |
| datageneral_custom_fields | Lista os campos pesonalizados vinculados ao departamento quando não há categoria selecionada. | Array |
| datageneral_custom_fields tickets | Lista de campos personalizados usados em chamados. | Array |
| datageneral_custom_fields tickets id | Identificador do campo personalizado. | String |
| datageneral_custom_fields tickets label | Label do campo personalizado. | String |
| datageneral_custom_fields tickets type | Informa o tipo do campo. Opções Disponíveis:
| Int |
| datageneral_custom_fields tickets options | Valores disponíveis do campo personalizado. | Array |
| datageneral_custom_fields tickets mandatory | Informa se o preenchimento do campo é obrigatório. | Boolean |
| datageneral_custom_fields tickets operation | Lista os tipos de operação em que este campo pode ser utilizado. | Array |
| datageneral_custom_fields tickets operation open | Informa se o campo pode ser usado para a abertura de chamados. | Boolean |
| datageneral_custom_fields tickets operation close | Informa se o campo pode ser usado para o encerramento de chamados. | Boolean |
| datageneral_custom_fields tickets operation evaluation | Informa se o campo pode ser usado para a avaliação de chamados. | Boolean |
| datageneral_custom_fields chats | Lista de campos personalizados usados em chats. | Array |
| datageneral_custom_fields chats id | Identificador do campo personalizado. | String |
| datageneral_custom_fields chats label | Label do campo personalizado. | String |
| datageneral_custom_fields chats type | Informa o tipo do campo. Opções Disponíveis:
| Int |
| datageneral_custom_fields chats options | Valores disponíveis do campo personalizado. | Array |
| datageneral_custom_fields chats mandatory | Informa se o preenchimento do campo é obrigatório. | Boolean |
| datageneral_custom_fields chats operation | Lista os tipos de operação em que este campo pode ser utilizado. | Array |
| datageneral_custom_fields chats operation open | Informa se o campo pode ser usado para a abertura de chats. | Boolean |
| datageneral_custom_fields chats operation evaluation | Informa se o campo pode ser usado para a avaliação de chats. | 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
