Open topic with navigation

DOCUMENTATION PORTAL
Human Capital Management | HCM - senior X
Note: This page was translated using automation resources with the purpose of providing content in your language more quickly. Consequently, it may have grammatical errors and similar situations. If the content is not useful in this state, in the page footer you can access the original material in Brazilian Portuguese and also give us opinions on this translation.
Human Capital Management - senior X - User Manual > Colabbe - Digital Hiring > Integrations > Integration via APIs > Search for details of different records (Queries)

Buscar detalhes de cadastros diversos (Queries) — APIs da Colabbe

Queries retornam os dados básicos de diversos tipos de cadastros e registros da base, como por exemplo: empresas, países, estados e cidades.

Esta documentação lista as queries que estão disponíveis nas APIs da Colabbe.

URL

POST <url_plataforma>/t/senior.com.br/bridge/1.0/rest/hcm/onboarding/actions/<query>

Substitua <url_plataforma> pela URL correspondente ao seu ambiente. Se for o ambiente de produção, substitua por: https://platform.senior.com.br

Substitua <query> pelo nome de uma das queries abaixo, referente ao registro que quer buscar com a API.

Cabeçalho (Header)

Authorization Bearer​ <access_token>
Content-Type application/json

Substitua <access_token> pela chave de acesso obtida a partir da API de autenticação na plataforma.

countryListQuery

Retorna as informações básicas do cadastro de países.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação dos países.
  id String Identificador do país.
  name String Nome do país.
  abbreviation String Abreviação do nome do país.
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name: "string", "abbreviation": "string", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

stateListQuery

Retorna as informações básicas do cadastro de estados/unidades federativas.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação dos estados/unidades federativas.
  id String Identificador do estado.
  name String Nome do estado.
  abbreviation String Abreviação do nome do estado.
  country String País ao qual o estado pertence.
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name: "string", "abbreviation": "string", "country": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

cityListQuery

Retorna as informações básicas do cadastro de cidades.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação das cidades.
  id String Identificador da cidade.
  name String Nome da cidade.
  state String Estado ao qual a cidade pertence.
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name: "string", "state": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

nationalityListQuery

Retorna as informações básicas do cadastro de nacionalidades.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação das nacionalidades.
  id String Identificador da nacionalidade.
  code Integer Código da nacionalidade.
  name String Nome da nacionalidade.
  type String

Tipo da nacionalidade.

ClosedValores possíveis:
  • BRAZILIAN = Brasileiro
  • OTHER = Outro
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": 0, "name: "string", "type": "BRAZILIAN", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

religionListQuery

Retorna as informações básicas do cadastro de religiões.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação das religiões.
  id String Identificador da religião.
  code Integer Código da religião.
  name String Descrição da religião.
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": 0, "name: "string", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

bankListQuery

Retorna as informações básicas do cadastro de bancos.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação dos bancos.
  id String Identificador do banco.
  code Integer Número do banco.
  name String Descrição do banco.
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": 0, "name: "string", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

degreeOfEducationListQuery

Retorna as informações básicas do cadastro de graus de instrução.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação dos graus de instrução.
  id String Identificador único do grau de instrução.
  code Integer Código do grau de instrução.
  name String Nome do grau de instrução.
  type String

Tipo do grau de instrução.

ClosedValores possíveis:
  • ILLITERATE = 01 - Analfabeto, inclusive o que, embora tenha recebido instrução, não se alfabetizou
  • ELEMENTARY_SCHOOL_INCOMPLETE = 02 - Ensino Fundamental Incompleto
  • ELEMENTARY_SCHOOL_COMPLETE = 03 - 5º ano completo do Ensino Fundamental
  • MIDDLE_SCHOOL_INCOMPLETE = 04 - Do 6º ao 9º ano do Ensino Fundamental incompleto (antiga 5ª a 8ª série)
  • MIDDLE_SCHOOL_COMPLETED = 05 - Ensino Fundamental Completo
  • HIGH_SCHOOL_INCOMPLETE = 06 - Ensino Médio incompleto
  • HIGH_SCHOOL_COMPLETED = 07 - Ensino Médio completo
  • HIGHER_INCOMPLETE = 08 - Educação Superior incompleta
  • HIGHER_COMPLETED = 09 - Educação Superior completa
  • POST_GRADUATED = 10 - Pós-Graduação completa
  • MASTER = 11 - Mestrado completo
  • DOCTORAL = 12 - Doutorado completo
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": 0, "name: "string", "type": "ILLITERATE", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

companyListQuery

Retorna as informações básicas do cadastro de empresas.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação das empresas.
  id String Identificador da empresa.
  companyName String Nome da empresa.
  code String Código externo da empresa.
  enabled String

Indicativo se a empresa está ativa ou não.

ClosedValores possíveis:
  • ACTIVE = Ativa
  • INACTIVE = Inativa
  branchOffice { } Filiais da empresa.
    id String Identificador único do registro.
    company { } - Estabelecimento matriz.
    branchOfficeName String Razão social.
    tradingName String Nome fantasia.
    enabled String

Indicativo se a filial está ativa ou não.

ClosedValores possíveis:
  • ACTIVE = Ativa
  • INACTIVE = Inativa
    code String Código do sistema externo.
    createdBy String  
    createdDate String  
    lastModifiedBy String  
    lastModifiedDate String  
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "companyName": "string", "code: "string", "enabled": "ACTIVE", "branchOffice": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "company": {}, "branchOfficeName": "string", "tradingName": "string", "enabled": "ACTIVE", "code": "string", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ], "createdBy: "string", "createdDate: "2022-02-07T17:04:25.021Z", "lastModifiedBy: "string", "lastModifiedDate: "2022-02-07T17:04:25.021Z", } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

companyQuery

Retorna uma lista das empresas existentes.

Parâmetros:

* Obrigatórios

Nome Tipo Descrição
size * Integer Tamanho das páginas.
offset * Integer Indicativo da página atual.
filter * String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
result { } Relação das empresas.
  id String Identificador único da empresa.
  companyName String Nome da empresa.
  code String Código do sistema externo.
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "result": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "companyName": "SENIOR SISTEMAS", "code" : "1234" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

branchOfficeListQuery

Retorna as informações básicas do cadastro de filiais.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação das empresas.
  id String Identificador único do registro.
  company { } Estabelecimento matriz.
    id String Identificador da empresa.
    companyName String Nome da empresa.
    code String Código externo da empresa.
    enabled String

Indicativo se a empresa está ativa ou não.

ClosedValores possíveis:
  • ACTIVE = Ativa
  • INACTIVE = Inativa
    branchOffice { } - Filiais.
    createdBy String  
    createdDate String  
    lastModifiedBy String  
    lastModifiedDate String  
  branchOfficeName String Razão social.
  tradingName String Nome fantasia.
  enabled String

Indicativo se a filial está ativa ou não.

ClosedValores possíveis:
  • ACTIVE = Ativa
  • INACTIVE = Inativa
  code String Código do sistema externo.
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "company": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "companyName": "string", "code": "string", "enabled": "ACTIVE", "branchOffice": [ {} ], "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" }, "branchOfficeName": "string", "tradingName": "string", "enabled": "ACTIVE", "code" : "string", "createdBy: "string", "createdDate: "2022-02-07T17:04:25.021Z", "lastModifiedBy: "string", "lastModifiedDate: "2022-02-07T17:04:25.021Z", } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

branchOfficeQuery

Retorna uma lista das filiais existentes.

Parâmetros:

* Obrigatórios

Nome Tipo Descrição
size * Integer Tamanho das páginas.
offset * Integer Indicativo da página atual.
filter * String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.
company * String

Identificador (ID) da empresa vinculada às filiais.

Para obter os identificadores das empresas, você pode fazer uma requisição para o endpoint companyListQuery.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
result { } Relação das filiais.
  id String Identificador único da filial.
  branchOfficeName String Razão social.
  tradingName String Nome fantasia.
  code String Código do sistema externo.
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "result": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "branchOfficeName": "SENIOR SISTEMAS S/A", "tradingName": "SENIOR SISTEMAS", "code" : "1234" } ] }
ClosedExemplo da resposta (default):

Exemplo de resposta caso o campo company não seja informado na requisição:

 { "message": "company is required", "reason": "BAD_REQUEST" }

jobPositionListQuery

Retorna as informações básicas do cadastro de cargos.

Parâmetros (opcionais):

Nome Tipo Descrição
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
totalElements Integer Total de registros encontrados.
totalPages Integer Total de páginas encontradas.
contents { } Relação dos cargos.
  id String Identificador único do registro.
  name String Nome do cargo.
  enabled String

Indicativo se o cargo está ativo ou não.

ClosedValores possíveis:
  • ACTIVE = Ativa
  • INACTIVE = Inativa
  code String Código externo.
  createdBy String  
  createdDate String  
  lastModifiedBy String  
  lastModifiedDate String  
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name: "string", "enabled": "ACTIVE", "code": "string", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

jobPositionQuery

Retorna uma lista dos cargos existentes.

Parâmetros:

* Obrigatórios

Nome Tipo Descrição
size * Integer Tamanho das páginas.
offset * Integer Indicativo da página atual.
filter * String Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Respostas:

Código Descrição Campos da resposta
200 Ok
Campo Tipo Descrição
result { } Relação de cargos.
  id String Identificador único do registro.
  name String Nome do cargo.
  code String Código do sistema externo.
401 Invalid credentials   -
default Error response
Campo Tipo Descrição
message String Mensagem descritiva do erro.
reason String Um código que representa a categoria da causa do erro.
ClosedExemplo da resposta (200): 
 { "result": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "ANALISTA DE SISTEMAS II", "code" : "1234" } ] }
ClosedExemplo da resposta (default): 
 { "message": "string", "reason": "BAD_REQUEST" }

Filtros adicionais (opcionais)

Os filtros listados a seguir permitem restringir os resultados retornados pelas queries. Para usar estes filtros, você precisa concatená-los na URL da requisição.

Nome do filtro Tipo esperado Descrição do filtro
size Integer Tamanho das páginas.
offset Integer Indicativo da página atual.
filter String

Filtro Open Data Protocol (OData) da senior X Platform que pode ser aplicado na pesquisa.

Para entender como aplicar este filtro na requisição, consulte a documentação de filtros no Portal de APIs da Senior.

Exemplo:

https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/hcm/onboarding/actions/countryListQuery?size=10&offset=1&filter=id gt 2 and id lt 5

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).