Integración de personas utilizando la API
Documentación sobre cómo integrar personas, utilizando la API Ronda senior X.
Prerrequisitos generales
- Tener al menos un tipo de documento registrado;
- Estar autenticado en Ronda senior X.
Registrar una persona
- llame al servicioOBTENER / tipo de documento;
- Elija un registro de la lista devuelta que tenga el artículorequerido establecido en "verdadero";
- Utilizar elidentificación de este tipo de documento en el servicio a continuación;
- Armar el JSON con los datos de la persona, el id del tipo de documento y el documento;
- llame al servicioCORREO /persona.
Si el servicio regresa exitosamente (HTTP 200), se devolverá JSON con todos los datos disponibles para la persona.
Excluir a una persona
- llame al servicioBORRAR /persona/{id}.
Búsqueda paginada de todas las personas
- llame al servicioOBTENER /persona/pagedsearchall.
Consultar un listado de personas por el nombre, como mínimo 3 caracteres
- llame al servicioOBTENER /persona/buscar.
Actualizar persona
- Consultar a la persona cuyos datos serán modificados;
- llame al servicioOBTENER /persona/{id};
- llame al servicioOBTENER /persona/{personaId}/foto consultar la fotografía de la persona buscada;
- llame al servicioENVIAR /persona/{personaId}/foto cambiar la foto de la persona;
- Cambie los datos deseados en JSON;
- llame al servicioPONER /persona pasando el JSON modificado.
Si el servicio regresa exitosamente (HTTP 200), no se devolverá ningún JSON.
Informaciones de los servicios
GET /documenttype
Notas de Implementación
Devolver una matriz de tipo de incidente
Respuesta Clase (Status 200)
Una matriz de tipo de documento
[
{
"id": 0,
"name": "string",
"label": "string",
"mask": "string",
"required": true,
"documentToREP": true
}
]
Parámetros
| Parámetros | Valor | Description | Tipo Parámetro | Tipo Fecha |
|---|---|---|---|---|
| token | (required) | Autenticación token | header | string |
Mensajes de Respuesta
| HTTP Código Estado | Razón | Modelo de Respuesta | Headers |
|---|---|---|---|
| 401 | Token es inválido o expirado | ||
| 500 | Error de Servidor | { "code": 0, "message": "string" } |
POST /person
Notas de Implementación
Crear un nuevo campo Person, Id será ignorado
Respuesta Clase (Status 200)
Persona creada
{
"id": 0,
"name": "string",
"documents": [
{
"id": 0,
"documentType": {
"id": 0,
"name": "string",
"label": "string",
"mask": "string",
"required": true,
"documentToREP": true
},
"document": "string"
}
],
"emails": [
{
"id": 0,
"preferential": true,
"emailAddress": "string"
}
],
"phones": [
{
"id": 0,
"preferential": true,
"ddi": 0,
"phoneNumber": "string",
"extensionLine": "string"
}
],
"gender": 0,
"birthday": "string",
"registry": "string",
"registerDate": "string",
"lastModificationDate": "string",
"address": "string",
"number": "string",
"district": "string",
"city": "string",
"uf": "string",
"cep": "string",
"nationality": "string",
"lastAccessDate": "string",
"situation": 0,
"hasValidRole": true,
"hasProvisoryRole": true
}
Parámetros
| Parámetros | Description | Tipo Parámetro | Tipo Fecha |
|---|---|---|---|
| token | Autenticación token | header | string |
| person | Person | body | { "id": 0, "name": "string", "documents": [ { "id": 0, "documentType": { "id": 0, "name": "string", "label": "string", "mask": "string", "required": true, "documentToREP": true }, "document": "string" } ], "emails": [ { "id": 0, "preferential": true, "emailAddress": "string" } ], "phones": [ { "id": 0, "preferential": true, "ddi": 0, "phoneNumber": "string", "extensionLine": "string" } ], "gender": 0, "birthday": "string", "registry": "string", "registerDate": "string", "lastModificationDate": "string", "address": "string", "number": "string", "district": "string", "city": "string", "uf": "string", "cep": "string", "nationality": "string", "lastAccessDate": "string", "situation": 0, "hasValidRole": true, "hasProvisoryRole": true } |
Mensajes de Respuesta
| HTTP Código Estado | Razón | Modelo de Respuesta |
|---|---|---|
| 401 | Token es inválido o expirado | |
| 403 | Operación denegada | |
| 500 | Error de Servidor | { "code": 0, "message": "string" } |
DELETE /person/{id}
Notas de Implementación
Borra a una persona
Parámetros
| Parámetros | Description | Tipo Parámetro | Tipo Fecha |
|---|---|---|---|
| token | Autenticación token | header | string |
| id | Id de persona | path | long |
Mensajes de Respuesta
| HTTP Código Estado | Razón | Modelo de Respuesta |
|---|---|---|
| 200 | Persona borrada | |
| 401 | Token es inválido o expirado | |
| 403 | Operación denegada | |
| 404 | Persona no encontrada | |
| 500 | Error de Servidor | { "code": 0, "message": "string" } |
GET /person/pagedsearchall
Notas de Implementación
Búsqueda paginada por todas las personas
Respuesta Clase (Status 200)
Un array paginado de personas
[
{
"id": 0,
"name": "string",
"mandatoryDocuments": [
{
"id": 0,
"documentType": {
"id": 0,
"name": "string",
"label": "string",
"mask": "string",
"required": true,
"documentToREP": true
},
"document": "string"
}
],
"preferentialPhone": {
"id": 0,
"preferential": true,
"ddi": 0,
"phoneNumber": "string",
"extensionLine": "string"
},
"preferentialEmail": {
"id": 0,
"preferential": true,
"emailAddress": "string"
}
}
]
Parámetros
| Parámetros | Description | Tipo Parámetro | Tipo Fecha |
|---|---|---|---|
| token | Autenticación token | header | string |
| page | Page number | query | integer |
| pageSize | Size of page | query | integer |
| situación | Filtro de ubicación física (0 = TODO, 1 = ACTIVO) | query | integer |
| onlyReceiveVisit | Filtra única persona que puede recibir la visita | query | boolean |
Mensajes de Respuesta
| HTTP Código Estado | Razón | Modelo de Respuesta |
|---|---|---|
| 401 | Token es inválido o expirado | |
| 500 | Error de Servidor | { "code": 0, "message": "string" } |
GET /person/search
Notas de Implementación
Búsqueda completa automática a persona
Respuesta Clase (Status 200)
El conjunto de información básica para búsqueda de personas es limitadas por 10 resultados
[
{
"id": 0,
"name": "string",
"mandatoryDocuments": [
{
"id": 0,
"documentType": {
"id": 0,
"name": "string",
"label": "string",
"mask": "string",
"required": true,
"documentToREP": true
},
"document": "string"
}
],
"preferentialPhone": {
"id": 0,
"preferential": true,
"ddi": 0,
"phoneNumber": "string",
"extensionLine": "string"
},
"preferentialEmail": {
"id": 0,
"preferential": true,
"emailAddress": "string"
}
}
]
Parámetros
| Parámetros | Description | Tipo Parámetro | Tipo Fecha |
|---|---|---|---|
| token | Autenticación token | header | string |
| term | Término del nombre de la persona, el apellido o el documento | query | string |
| situación | Filtro de ubicación física (0 = TODO, 1 = ACTIVO) | query | integer |
| onlyReceiveVisit | Filtra única persona que puede recibir la visita | query | boolean |
Mensajes de Respuesta
| HTTP Código Estado | Razón | Modelo de Respuesta |
|---|---|---|
| 401 | Token es inválido o expirado | |
| 500 | Error de Servidor | { "code": 0, "message": "string" } |
GET /person/{id}
Notas de Implementación
Retorna una persona
Respuesta Clase (Status 200)
Retorna una persona
{
"id": 0,
"name": "string",
"documents": [
{
"id": 0,
"documentType": {
"id": 0,
"name": "string",
"label": "string",
"mask": "string",
"required": true,
"documentToREP": true
},
"document": "string"
}
],
"emails": [
{
"id": 0,
"preferential": true,
"emailAddress": "string"
}
],
"phones": [
{
"id": 0,
"preferential": true,
"ddi": 0,
"phoneNumber": "string",
"extensionLine": "string"
}
],
"gender": 0,
"birthday": "string",
"registry": "string",
"registerDate": "string",
"lastModificationDate": "string",
"address": "string",
"number": "string",
"district": "string",
"city": "string",
"uf": "string",
"cep": "string",
"nationality": "string",
"lastAccessDate": "string",
"situation": 0,
"hasValidRole": true,
"hasProvisoryRole": true
}
Parámetros
| Parámetros | Description | Tipo Parámetro | Tipo Fecha |
|---|---|---|---|
| token | Autenticación token | header | string |
| id | Id de persona | path | long |
Mensajes de Respuesta
| HTTP Código Estado | Razón | Modelo de Respuesta |
|---|---|---|
| 401 | Token es inválido o expirado | |
| 404 | Persona no encontrada | |
| 500 | Error de Servidor | { "code": 0, "message": "string" } |
GET /person/{personId}/photo
Notas de Implementación
Retornar la url de la foto de una persona
Respuesta Clase (Status 200)
La url de la foto de una persona
{
"photoDate": "string",
"photoURL": "string"
}
Parámetros
| Parámetros | Description | Tipo Parámetro | Tipo Fecha |
|---|---|---|---|
| token | Autenticación token | header | string |
| personId | Person Id | path | string |
Mensajes de Respuesta
| HTTP Código Estado | Razón | Modelo de Respuesta |
|---|---|---|
| 401 | Token es inválido o expirado | |
| 404 | Persona no encontrada | |
| 500 | Error de Servidor | { "code": 0, "message": "string" } |
POST /person/{personId}/photo
Notas de Implementación
Actualizar foto de persona
Respuesta Clase (Estado 200)
Fecha de la foto de persona
{
"photoDate": "string",
"photoURL": "string"
}
Parámetros
| Parámetros | Description | Tipo Parámetro | Tipo Fecha |
|---|---|---|---|
| token | Autenticación token | header | string |
| personId | Id de una persona | path | long |
| file | La foto de persona | formData | file |
Mensajes de Respuesta
| HTTP Código Estado | Razón | Modelo de Respuesta |
|---|---|---|
| 401 | Token es inválido o expirado | |
| 403 | Operación denegada | |
| 500 | Error de Servidor | { "code": 0, "message": "string" } |
PUT /person
Notas de Implementación
Actualizar a una persona
Parameters
| Parámetros | Description | Tipo Parámetro | Tipo Fecha |
|---|---|---|---|
| token | Autenticación token | header | string |
| Person | Person | body | { "id": 0, "name": "string", "documents": [ { "id": 0, "documentType": { "id": 0, "name": "string", "label": "string", "mask": "string", "required": true, "documentToREP": true }, "document": "string" } ], "emails": [ { "id": 0, "preferential": true, "emailAddress": "string" } ], "phones": [ { "id": 0, "preferential": true, "ddi": 0, "phoneNumber": "string", "extensionLine": "string" } ], "gender": 0, "birthday": "string", "registry": "string", "registerDate": "string", "lastModificationDate": "string", "address": "string", "number": "string", "district": "string", "city": "string", "uf": "string", "cep": "string", "nationality": "string", "lastAccessDate": "string", "situation": 0, "hasValidRole": true, "hasProvisoryRole": true } |
Mensajes de Respuesta
| HTTP Código Estado | Razón | Modelo de Respuesta |
|---|---|---|
| 200 | Persona actualizada | |
| 401 | Token es inválido o expirado | |
| 403 | Operación denegada | |
| 404 | Persona no encontrada | |
| 500 | Error de Servidor | { "code": 0, "message": "string" } |
