Consultar um time

Como obter dados de um time específico utilizando API?

Para obter os dados de um time específico no Zeev utilizando API, siga os passos abaixo:

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

2. Obtenha os parâmetros necessários: Obtenha o código identificador do time (teamid) para utilizar o endpoint Consultar um time ou código original (teamcode) para utilizar o endpoint Consultar um time;

3. Enviar requisição: Envie a requisição para o endpoint que melhor atende a sua necessidade de acordo com os dados que possui;

4. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $select.

Ambos os parâmetros podem ser encontrados na página do Zeev em Acesso > Times ou como resultado de consultas de API's como explicado em Consultar um time

Obter time pelo código identificador (Auth)

get

Autorizações

AuthorizationstringObrigatório

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

Parâmetros de rota

teamIdinteger · int32Obrigatório

Código identificador do time

Respostas

200

Sucesso

idinteger · int32Opcional

Identificador do time

codestringOpcional

Código original / Integração

namestringOpcional

Nome do time

parentIdinteger · int32Opcional

Identificador do time hierarquicamente superior

levelstringOpcional

Relação de níveis hierarquicos

signstringOpcional

Sigla

alwaysVisiblebooleanOpcional

activebooleanOpcional

Indica se o time está ativo

descriptionstringOpcional

Descrição do time

typestringOpcional

Tipo de time

statestringOpcional

Estado associado ao time

citystringOpcional

Cidade associada ao time

400

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

401

Pessoa não autorizada

403

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

404

O registro não foi encontrado

429

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

500

Ocorreu algum erro interno no servidor

get/api/2/teams/{teamid}

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

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

Obter time pelo código original / integração (Auth)

get

Autorizações

AuthorizationstringObrigatório

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

Parâmetros de rota

teamCodestringObrigatório

Código original / integração do time

Respostas

200

Sucesso

idinteger · int32Opcional

Identificador do time

codestringOpcional

Código original / Integração

namestringOpcional

Nome do time

parentIdinteger · int32Opcional

Identificador do time hierarquicamente superior

levelstringOpcional

Relação de níveis hierarquicos

signstringOpcional

Sigla

alwaysVisiblebooleanOpcional

activebooleanOpcional

Indica se o time está ativo

descriptionstringOpcional

Descrição do time

typestringOpcional

Tipo de time

statestringOpcional

Estado associado ao time

citystringOpcional

Cidade associada ao time

400

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

401

Pessoa não autorizada

403

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

404

O registro não foi encontrado

429

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

500

Ocorreu algum erro interno no servidor

get/api/2/teams/code/{teamcode}

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

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

Exemplos de requisições para obter dados de um time específico

Node.js (utilizando teamId)

let teamId = 4268;

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/${teamId}`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

Node.js (utilizando teamCode)

let teamCode = "t3amC0de";

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,
  redirect: "follow"
};

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

---