Listar times

Como listar os times acessíveis pela pessoa autenticada na API?

Para listar os times acessíveis pela pessoa autenticada no Zeev, siga estes passos:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Enviar a requisição: Enviar requisição para Listar times;

3. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $filter, $select, $orderby e $top.

Listar times que a pessoa relacionada ao token tem permissão de visualizar (Auth)

get

Autorizações

Bearer

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de consulta

namestringOpcional

Nome do time para pesquisa

Respostas

200

Sucesso

application/jsontext/jsontext/xml

idinteger · int32Opcional

codestringOpcional

Código original / Integração

namestringOpcional

Nome do time

levelstringOpcional

Relação de nível hierárquicos

signstringOpcional

Sigla do time

parentIdinteger · int32Opcional

Identificador do time superior hierarquicamente

alwaysVisiblebooleanOpcional

activebooleanOpcional

Indica se o time está ativo

descriptionstringOpcional

Descrição do time

typestringOpcional

Tipo do time

statestringOpcional

Estado relacionado ao time

citystringOpcional

Cidade relacionada ao time

400

Solicitação ou dados da solicitação são inválidas

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

Pessoa não tem permissão de executar essa operação

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

Muitas requisições em um determinado período de tempo

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

get

/api/2/teams

HTTPcURLJavaScriptPython

GET /api/2/teams HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "code": "text",
    "name": "text",
    "level": "text",
    "sign": "text",
    "parentId": 1,
    "alwaysVisible": true,
    "active": true,
    "description": "text",
    "type": "text",
    "state": "text",
    "city": "text",
    "parent": {
      "id": 1,
      "default": "text",
      "name": "text"
    }
  }
]

Exemplo de requisição para listar times acessíveis pela pessoa autenticada

Node.js

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "GET",
  headers: myHeaders
};

try {
  const response = await fetch("https://seu_endereco.do.zeev/api/2/teams", requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

//Se desejar utilize o parâmetro name para filtrar por nome

let teamName = "Recursos Humanos";
let urlAddress = `https://seu_endereco.do.zeev/api/2/teams?name=${teamName}`

try {
  const response = await fetch(urlAddress, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

/*
  Mantendo o mesmo padrão de requisição, 
  manipule a URL para incluir os filtros desejados 
  no padrão oData, veja algusn exemplos abaixo
*/

//filtrar times que contenham Adm no nome
let urlAddress = "https://seu_endereco.do.zeev/api/2/teams?$filter=contains(name,'Adm')";
//retornar os 10 primeiros registros 
let urlAddress = "https://seu_endereco.do.zeev/api/2/teams?$top=10";
//retornar apenas id, código original e nome dos times
let urlAddress = "https://seu_endereco.do.zeev/api/2/teams?$select=id,code,name";
//retornar os 10 ultimos times ordenados
let urlAddress = "https://seu_endereco.do.zeev/api/2/teams?$orderby=id desc&$top=10"

---

Links relacionados:

• O que é preciso para fazer integrações do Zeev para outros sistemas?

• Como autenticar nas APIs do Zeev

• Como controlar o volume máximo de requisições à APIs

• Como acessar o Swagger / OpenAPI

• Como criar times