Retorna uma lista paginada dos integrantes de grupos cadastrados no módulo Organização.
URL
{RMUrl}/api/organization/groups/<Códigodogrupo>/members[?[[&]$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
GroupID: esse parâmetro é fornecido na URL e não precisa ser enviado através do GET.
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 os integrantes listados 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 filtros, como os operadores suportados, quais filtros se aplicam a quais tipos de dados e mais exemplos, veja o Apêndice 3: Filtros.
EXEMPLOS DE SOLICITAÇÃO
Os 10 primeiros integrantes do grupo (por padrão, 10 integrantes são listados por vez):
{RMUrl}/api/organization/groups/6fe49ce4-56d4-475f-9483-1adca6b2976c/members
Os integrantes do grupo de 11 a 20 (segunda página):
{RMUrl}/api/organization/groups/6fe49ce4-56d4-475f-9483-1adca6b2976c/members?page=2
Filtrar por "Joana" no campo "Name":
{RMUrl}/api/organization/groups/6fe49ce4-56d4-475f-9483-1adca6b2976c/members?$filter=substringof('Joana',Name)
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre as pessoas que fazem parte do grupo de acordo com os filtros e o tamanho da página especificados.
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"},
{
"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"},
}
]