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:
Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
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?
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):
oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita
$filter
,$select
,$orderby
e$top
.
Código identificador da pessoa
Sucesso.
Solicitação ou dados da solicitação são inválidas
Pessoa não autorizada
Pessoa não tem permissão de executar essa operação
O registro não foi encontrado
Muitas requisições em um determinado período de tempo
Ocorreu algum erro interno no servidor
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:
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:
Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
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;
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;
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;
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):
Código identificador da pessoa
Código identificador da função
Código identificador do time
Sucesso.
Solicitação ou dados da solicitação são inválidas
Pessoa não autorizada
Pessoa não tem permissão de executar essa operação
O registro não foi encontrado
Muitas requisições em um determinado período de tempo
Ocorreu algum erro interno no servidor
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:
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:
Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
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;
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;
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;
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):
Código identificador da pessoa
Código identificador da função
Código identificador do time
Sucesso.
Solicitação ou dados da solicitação são inválidas
Pessoa não autorizada
Pessoa não tem permissão de executar essa operação
O registro não foi encontrado
Muitas requisições em um determinado período de tempo
Ocorreu algum erro interno no servidor
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:
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:
Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
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;
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.
Código identificador da pessoa de origem
Código identificador da pessoa de destino
Sucesso.
Solicitação ou dados da solicitação são inválidas
Pessoa não autorizada
Pessoa não tem permissão de executar essa operação
O registro não foi encontrado
Muitas requisições em um determinado período de tempo
Ocorreu algum erro interno no servidor
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
}
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:
Atualizado