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.
Fetch all attachments from a pre-admission — Colabbe APIs
Fetches all attachments of a pre-admission, based on the unique identifier of that pre-admission.
API definitions:
url
Header
parameters
Example
Answers
url
POST <platform_url>/t/senior.com.br/bridge/1.0/rest/hcm/onboarding/queries/getAllURLFilesFromPreAdmissionId
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
* Required
Parameter
Type
Description
preAdmissionId *
String
Pre-admission unique identifier.
Example
{ "preAdmissionId": "string", }
Answers
Code
Description
response fields
200
OK
Field
Type
Description
result { }
Request results.
key
String
Link (URL) of attachment for download.
value
String
Attachment description.
401
Invalid credentials
-
default
error response
Field
Type
Description
message
String
Descriptive error message.
reason
String
A code that represents the category of the cause of the error.
Example of the answer (200):
{ "result": [ { "key": "https://www.site.com/imagem1.png", "value": "Address proof" }, { "key": "https://www. site.com/imagem2.png", "value": "RG - front" }, { "key": "https://www.site.com/imagem3.png", "value": "RG - back" } ] }
Este artigo ajudou você?
Sim
Não
Agradecemos pelo seu feedback! Vamos avaliar o comentário e alterar o conteúdo relacionado, caso seja necessário.