Gerenciar times e funções da pessoa

Como consultar as funções e times de uma pessoa no Zeev, utilizando API?

Para consultar as funções de uma pessoa, siga os passos abaixo:

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

2. Obtenha o userid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Pessoas ou utilizando consulta de API's como nos exemplos que estão disponíveis em Como listar os dados de cadastro de todas as pessoas utilizando API do Zeev?

3. Enviar a Requisição: Utilize o endpoint Gerenciar times e funções da pessoa para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

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

Listar posições e times por código da pessoa (Auth)

get

Autorizações

Bearer

AuthorizationstringObrigatório

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

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

Respostas

200

Sucesso.

application/jsontext/jsontext/xml

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/users/{userid}/positions

HTTPcURLJavaScriptPython

GET /api/2/users/{userid}/positions HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "position": {
      "id": 1,
      "code": "text",
      "name": "text",
      "level": "text"
    },
    "team": {
      "id": 1,
      "code": "text",
      "name": "text",
      "sign": "text",
      "level": "text"
    }
  }
]

Exemplo de requisição para consultar as funções de uma pessoa:

Node.js

let userId = 432;

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

---

Como adicionar uma função e time à uma pessoa utilizando a API?

Se você deseja atribuir duas ou mais funções a uma pessoa, considere utilizar o endpoint de cadastro, especificando a lista de funções com o valor de ifExists igual a append ou update. ver mais em Como cadastrar pessoas no Zeev utilizando API?.

Para adicionar uma função a uma pessoa 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 o userid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Pessoas ou utilizando consulta de API's como nos exemplos que estão disponíveis em Listar pessoas;

3. Obtenha a positionid: Obtenha o código identificador da função, disponível no Zeev na página Acesso > Funções ou através de consultas de API como nos exemplos disponíveis em Listar funções;

4. Obtenha o teamid: Obtenha o código identificador do time, disponível na página Acesso > Times ou através de consultas de API como nos exemplos disponíveis em Listar times;

5. Enviar a Requisição: Utilize o endpoint Gerenciar times e funções da pessoa para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

Adicionar um time e função a uma pessoa (Auth)

post

Autorizações

Bearer

AuthorizationstringObrigatório

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

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

positionIdinteger · int32Obrigatório

Código identificador da função

teamIdinteger · int32Obrigatório

Código identificador do time

Respostas

200

Sucesso.

application/jsontext/jsontext/xml

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

post

/api/2/users/{userid}/positions/{positionid}/{teamid}

HTTPcURLJavaScriptPython

POST /api/2/users/{userid}/positions/{positionid}/{teamid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "userId": 1,
  "positionId": 1,
  "teamId": 1
}

Exemplo de requisição para adicionar uma função à uma pessoa:

Node.js

let userId = 123;
let positionId = 321;
let teamId = 789;

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

const raw = "";

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw
};

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

---

Como remover uma função e time de uma pessoa utilizando API?

Para remover uma função de uma pessoa 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 o userid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Pessoas ou utilizando consulta de API's como nos exemplos que estão disponíveis em Listar pessoas;

3. Obtenha a positionid: Obtenha o código identificador da função, disponível no Zeev na página Acesso > Funções ou através de consultas de API como nos exemplos disponíveis em Listar funções;

4. Obtenha o teamid: Obtenha o código identificador do time, disponível na página Acesso > Times ou através de consultas de API como nos exemplos disponíveis em Listar times;

5. Enviar a Requisição: Utilize o endpoint abaixo para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

Excluir um time e função de uma pessoa (Auth)

delete

Autorizações

Bearer

AuthorizationstringObrigatório

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

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

positionIdinteger · int32Obrigatório

Código identificador da função

teamIdinteger · int32Obrigatório

Código identificador do time

Respostas

204

Sucesso.

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

delete

/api/2/users/{userid}/positions/{positionid}/{teamid}

HTTPcURLJavaScriptPython

DELETE /api/2/users/{userid}/positions/{positionid}/{teamid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

Sem conteúdo

Exemplo de requisição para remover uma função de um usuário:

Node.js

let userId = 123;
let positionId = 321;
let teamId = 789;

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

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

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/positions/${positionId}/${teamId}`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Como copiar as funções e times de uma pessoa para outra utilizando API?

Para copiar as funções de uma pessoa para outra 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. Obter os parâmetros: O parâmetro userid é o código identificador da pessoa de quem se deseja copiar as funções o newuserid é o código identificador da pessoa a quem se deseja atribuir as funções. Ambos podem ser obtidos na página do Zeev Acesso > Pessoas, ou através de consultas de API como nos exemplos disponíveis em Listar pessoas;

3. Enviar a Requisição: Utilize o endpoint Gerenciar times e funções da pessoa para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

Tarefas pendentes não serão copiadas.

Copia todos os times e funções de uma pessoa para outra (Auth)

post

Autorizações

Bearer

AuthorizationstringObrigatório

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

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa de origem

newUserIdinteger · int32Obrigatório

Código identificador da pessoa de destino

Respostas

200

Sucesso.

application/jsontext/jsontext/xml

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

post

/api/2/users/{userid}/positions/copy/{newuserid}

HTTPcURLJavaScriptPython

POST /api/2/users/{userid}/positions/copy/{newuserid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "from": 1,
  "to": 1
}

Node.js

let userId = 456;
let newUserId = 321;

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: "POST",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/groups/copy/${newUserId}`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

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

• Vincular pessoas a times e funções