Fetch Invitation Templates — Colabbe APIs
Returns invitation templates to be sent in pre-admissions.
API definitions:
url
POST<platform_url>/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/queries/inviteModelQuery
replace<platform_url>by the URL corresponding to your environment. If it's the production environment, replace it with:https://platform.senior.com.br
Header
| Authorization | Bearer<access_token> |
|---|---|
| Content-Type | application/json |
replace<access_token>by the access key obtained from thePlatform Authentication API.
parameters
| Parameter | Type | Description |
|---|---|---|
| size | integrate |
Page size (number of records to be displayed on each page). When not informed, the default page size is 10 records. |
| offset | integrate |
Current page number. The first page starts at 0 (zero). When not informed, the default page is 0 (zero). |
| filter | String |
Filter to be applied in the search, based on the model name. This is a default senior X Platform filter. For details on how to use it, see thefilter documentation on the Senior API Portal. |
Example
{ "size": "10", "offset": "0", "filter": "string" }
|
Answers
| Code | Description | response fields | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 200 | OK |
|
||||||||||||||||||||||||
| 401 | Invalid credentials | - | ||||||||||||||||||||||||
| default | error response |
|
||||||||||||||||||||||||
Example of the answer (200):
{ "inviteModelData": [ { "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "country": "string", "deadline": "string", } ] }
|
Example response (default):
{ "message": "string", "reason": "BAD_REQUEST" }
|
Observation
By default, the endpointinviteModelQuery applies the filter below, causing it to return only the models that areactive:
enabled eq ACTIVE and containing(lower(name), lower(''))
English
Español
