Gestão de Pessoas - senior X - Manual do Usuário > Admissão Digital > Integrações > Integração via APIs > Buscar modelos de convite (inviteModelQuery)

Buscar modelos de convite — APIs da Admissão Digital

Retorna os modelos de convite para que sejam enviados nas pré-admissões.

Definições da API:

URL
Cabeçalho
Parâmetros
Exemplo
Respostas

URL

POST <url_plataforma>/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/queries/inviteModelQuery

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

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.

Parâmetros

Parâmetro	Tipo	Descrição
size	Integer	Tamanho da página (quantidade de registros que deve ser apresentada em cada página). Quando não é informado, o tamanho padrão das páginas é de 10 registros.
offset	Integer	Número da página atual. A primeira página inicia em 0 (zero). Quando não é informado, a página padrão é 0 (zero).
filter	String	Filtro a ser aplicado na pesquisa, baseado no nome do modelo. Este é um filtro padrão da XPlatform. Para ver detalhes de como usá-lo, veja a documentação do filtro no Portal de APIs da Senior.

Parâmetro

Tipo

Descrição

size

Integer

Tamanho da página (quantidade de registros que deve ser apresentada em cada página).

Quando não é informado, o tamanho padrão das páginas é de 10 registros.

offset

Integer

Número da página atual.

A primeira página inicia em 0 (zero).

Quando não é informado, a página padrão é 0 (zero).

filter

String

Filtro a ser aplicado na pesquisa, baseado no nome do modelo.

Este é um filtro padrão da XPlatform. Para ver detalhes de como usá-lo, veja a documentação do filtro no Portal de APIs da Senior.

Exemplo

{
  "size": "10",
  "offset": "0",
  "filter": "string"
}

Respostas

Código

Descrição

Campos da resposta

200

Campo		Tipo	Descrição
inviteModelData { }			Lista de registros de modelos de convite retornados pela requisição.
	modelId	String	Identificador do modelo de convite.
	name	String	Descrição do modelo de convite.
	country	String	País relacionado ao modelo de convite.
	deadline	Integer	Prazo definido para o convite.

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.

Observação

Por padrão, o endpoint inviteModelQuery aplica o filtro abaixo, fazendo com que ele retorne somente os modelos que estiverem ativos:

enabled eq ACTIVE and containing(lower(name), lower(''))

PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas \| HCM - senior X