Show Register Type
Este endpoint permite recuperar la información de un formulario de registro asociado a la compañia.
Como respuesta, se entrega el nombre la compañia que posee el formulario (company_name), el nombre del formularo de registro (name), el nombre del servicio proveedor de información que está haciendo uso de este registro (information_provider), un arreglo con todos los campos presentes en el formulario (allowed_fields) y un arreglo con los campos de formulario que son obligatorios (required_fields).
Endpoint
Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Authorization | Bearer {{access_token}} | access_token obtained in Atenea |
Method: GET
URL: https://api.trust.lat/trust-idp/v1/companies/:company_id/register_types/:register_name/information_provider/:provider_name
Path Variables:
Key | Value Example | Description |
---|---|---|
company_id | -1 | Identificador de la compañia, provisto por la empresa Trust. Obligatorio |
register_name | nin_register | Nombre del formulario de registro. Obligatorio |
provider_name | test_idp | Nombre del servicio proveedor de información que hace uso del registro. Obligatorio |
caution
Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea.
Code Examples
- Curl
- JavaScript
- Python
curl --location --request GET 'https://api.trust.lat/trust-idp/v1/companies/:company_id/register_types/:register_name/information_provider/:provider_name' \
--header 'Authorization: Bearer `{{access_token}}`'
import requests
url = "https://api.trust.lat/trust-idp/v1/companies/:company_id/register_types/:register_name/information_provider/:provider_name"
payload={}
headers = {
'Authorization': 'Bearer `{{access_token}}`'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var config = {
method: 'get',
url: 'https://api.trust.lat/trust-idp/v1/companies/:company_id/register_types/:register_name/information_provider/:provider_name',
headers: {
'Authorization': 'Bearer `{{access_token}}`'
}
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Responses
HTTP Code: 200 OK
Credential processed successfully
{
"code": 200,
"resource": "Register Type",
"data": {
"name": "nin_register",
"information_provider": "test_idp",
"required_fields": [
"nin"
],
"allowed_fields": [
"nin",
"name",
"lastname",
"two_factor_authentication"
],
"company_name": "Test Company"
},
"message": "Found"
}
HTTP Code: 403 Forbidden
Forbidden
{
"code": 403,
"message": "Forbidden"
}
HTTP Code: 404 Not Found
Company Not Present
{
"code": 404,
"resource": "Company Config",
"message": "Not found"
}
Register Not Found
{
"code": 404,
"resource": "Register Type",
"message": "Not found"
}