Show All Register Types

Este endpoint permite recuperar la información de un listado de formularios de registros asociado a la compañia.

Como respuesta, se entrega un arreglo de diccionarios con información sobre distintos registros. Dentro de dichos diccionarios vienen los campos company_name, name, information_provider, allowed_fields y required_fields. Para mayor información sobre estos campos, revisar endpoint ver formulario de registro.

Se puede personalizar el arreglo presente en la respuesta con los parámetros de búsqueda page y per_page, los cuales controlan la páginación de la respuesta. Sus valores por defecto son 1 y 5, respectivamente.

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

caution

Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea.

Como obtener un access token

Query Params

Los filtros disponibles son los siguientes:

Field	Description
page	Posición de la página a visualizar.
per_page	Número de elementos presentes dentro de una página.
from_date	Fecha de inicio de búsqueda.
until_date	Fecha límite de búsqueda.

Path Variables

Key	Value Example	Description
company_id	-1	Identificador de la compañía a la cual pertenecen los formularios de registro.

Code Examples

Curl

curl --location --request GET 'https://api.trust.lat/trust-idp/v1/companies/:company_id/register_types?page=1&per_page=5' \
--header 'Authorization: Bearer `{{access_token}}`'

JavaScript

import requests

url = "https://api.trust.lat/trust-idp/v1/companies/:company_id/register_types?page=1&per_page=5"

payload={}
headers = {
  'Authorization': 'Bearer `{{access_token}}`'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Python

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.trust.lat/trust-idp/v1/companies/:company_id/register_types?page=1&per_page=5',
  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

Registers Found

{
    "code": 200,
    "resource": "Register Type",
    "data": [
        {
            "name": "bio_register",
            "information_provider": "test",
            "required_fields": [
                "nin"
            ],
            "allowed_fields": [
                "nin",
                "name",
                "lastname",
                "email",
                "phone_number",
                "username"
            ],
            "company_name": "Test Company"
        },
        {
            "name": "user_register",
            "information_provider": "test",
            "required_fields": [
                "username"
            ],
            "allowed_fields": [
                "nin",
                "name",
                "lastname",
                "email",
                "phone_number",
                "username"
            ],
            "company_name": "Test Company"
        },
        {
            "name": "email_register",
            "information_provider": "test",
            "required_fields": [
                "email"
            ],
            "allowed_fields": [
                "nin",
                "name",
                "lastname",
                "email",
                "phone_number",
                "username"
            ],
            "company_name": "Test Company"
        }
    ],
    "message": "Found",
    "page": 1,
    "per_page": 5,
    "total": 3
}

Registers Not Found

{
    "code": 200,
    "resource": "Register Type",
    "data": [],
    "message": "Found",
    "page": 1,
    "per_page": 5,
    "total": 0
}

HTTP Code: 403 Forbidden

Forbidden

{
    "code": 403,
    "message": "Forbidden"
}

HTTP Code: 404 Not Found

Company Not Found

{
    "code": 404,
    "resource": "Company Config",
    "message": "Not found"
}