Retorna uma lista paginada de pessoas do módulo Oganização.
URL
{RMUrl}/api/Organization/people[?[[&]$filter=<filtro>][[&]page=<Página>][[&]page_size=<Tamanhodapágina>][[&]$orderby=<campo1[desc],campo2[desc]…campoN[desc]>]]
MÉTODO DE SOLICITAÇÃO
GET
PARÂMETROS DA URL
page: número de páginas a serem exibidas. Valores válidos: de 1 ao número máximo de páginas. Se omitido, o valor 1 é utilizado. Se o valor for maior que o número máximo de páginas, uma lista em branco será retornada.
page_size: número de itens exibidos por página. Valores válidos: de 1 a 1.000. Se omitido, o valor padrão de 10 itens por página é utilizado.
filter: consulta baseada na sintaxe do protocolo OData para configurar filtros. Os campos permitidos estão listados abaixo. Siga os exemplos para identificar as operações permitidas.
orderby: ordena as pessoas listadas na página por campo. Para ordenar por mais de um campo, utilize a vírgula entre os campos. Para utilizar a ordem decrescente, digite a palavra chave "desc" para cada campo desejado. Os campos permitidos estão listados abaixo.
CAMPOS SUPORTADOS POR FILTRO
Guid Id;
string Name;
string Description;
string Email;
string Phone;
string AdditionalInformation;
string Login;
string Status;
Para informações detalhadas sobre os filtros, como os operadores suportados, quais filtros se aplicam a quais tipos de dados e mais exemplos, veja o Apêndice 3: Filtros.
As 10 primeiras pessoas (por padrão, 10 pessoas são listadas por vez):
{RMUrl}/api/Organization/people
As pessoas de 11 a 20 (segunda página):
{RMUrl}/api/Organization/people?page=2
Filtrar pelo ID da pessoa:
{RMUrl}/api/Organization/people?$filter=Id eq guid'6fe49ce4-56d4-475f-9483-1adca6b2976c'
Filtrar por "Joana" no campo "Name":
{RMUrl}/api/Organization/people?$filter=substringof('Joana',Name)
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre as pessoas de acordo com os filtros e o tamanho da página especificados.
People[].
O objeto People está no seguinte formato:
People
{
Guid Id;
string Name;
string Description;
string Email;
string Phone;
string AdditionalInformation;
string Login;
string Status;
object CustomAttributes[];
}
O campo Status pode assumir os seguintes valores: "Active" e "Blocked". Este campo não aceita filtros com o operador substrigof. Para retornar a lista de usuários sem login, utilize ?$filter=Login eq null.
Para mais informações sobre os atributos customizados, veja o tópico Apêndice 1: Tipos de atributo.
EXEMPLO DE RESPOSTAS DE SUCESSO
[
{
"Id":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"Maria Helena"
"Description":"Funcionário do RH",
"Email":"maria@exemplo.com.br",
"Phone":"5555-0000",
"AdditionalInformation":"Gerente do RH",
"Login":"mhelena",
"Status":"Active"},
"CustomAttributes":{
"link":"https:\/\/empresa.com.br",
"text":"Texto"
}
},
{
"Id":"63e5fe02-5773-4a49-ba13-22506f022316",
"Name":"Joana Silveira"
"Description":"Funcionário da Segurança Patrimonial",
"Email":"joana@exemplo.com.br",
"Phone":"5555-6555",
"AdditionalInformation":"Segurança do período noturno",
"Login":"joana",
"Status":"NoAccess"}
},
{
"Id":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"Carlos Loureiro"
"Description":"Funcionário do Marketing",
"Email":"carlos@exemplo.com.br",
"Phone":"5555-7777",
"AdditionalInformation":"Gerente do Marketing",
"Login":"carlos",
"Status":"Blocked"
}
]