Saltar al contenido principal
API docs by Redocly

Searchpe API (4.1.1)

Download OpenAPI specification:Download

Searchpe API Support: projectopenubl@googlegroups.com URL: https://project-openubl.github.io/ License: Apache 2.0 Terms of Service

Searchpe REST API definitions for you to consume.

Basic User Resource

Get users

Get users

Authorizations:
NoneNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user

Creates a new user

Authorizations:
NoneNone
Request Body schema: application/json
id
integer <int64>
fullName
string
username
required
string [ 3 .. 250 ] characters ^[a-zA-Z0-9._-]{3,}$
password
required
string [ 3 .. 250 ] characters
permissions
required
Array of strings non-empty unique

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "fullName": "string",
  • "username": "string",
  • "password": "string",
  • "permissions": [
    ]
}

Get user

Get user

Authorizations:
NoneNone
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "fullName": "string",
  • "username": "string",
  • "password": "string",
  • "permissions": [
    ]
}

Update user

Update username or password. It won't update current role

Authorizations:
NoneNone
path Parameters
id
required
integer <int64>
Request Body schema: application/json
id
integer <int64>
fullName
string
username
required
string [ 3 .. 250 ] characters ^[a-zA-Z0-9._-]{3,}$
password
required
string [ 3 .. 250 ] characters
permissions
required
Array of strings non-empty unique

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "fullName": "string",
  • "username": "string",
  • "password": "string",
  • "permissions": [
    ]
}

Delete user

Delete user

Authorizations:
NoneNone
path Parameters
id
required
integer <int64>

Responses

Contribuyente Resource

Search contribuyentes

Get contribuyentes in a page

Authorizations:
NoneNone
query Parameters
filterText
string
limit
integer <int32> <= 1000
Default: "10"
offset
integer <int32> <= 9000
Default: "0"
sort_by
Array of strings
tipoPersona
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get contribuyente by numeroDocumento

Get contribuyentes by numeroDocumento

Authorizations:
NoneNone
path Parameters
numeroDocumento
required
string

Responses

Response samples

Content type
application/json
{
  • "versionId": 0,
  • "ruc": "string",
  • "dni": "string",
  • "nombre": "string",
  • "estado": "string",
  • "condicionDomicilio": "string",
  • "ubigeo": "string",
  • "tipoVia": "string",
  • "nombreVia": "string",
  • "codigoZona": "string",
  • "tipoZona": "string",
  • "numero": "string",
  • "interior": "string",
  • "lote": "string",
  • "departamento": "string",
  • "manzana": "string",
  • "kilometro": "string"
}

Current User Resource

/api/current-user/credentials

Authorizations:
NoneNone
Request Body schema: application/json
newPassword
string

Responses

Request samples

Content type
application/json
{
  • "newPassword": "string"
}

/api/current-user/profile

Authorizations:
NoneNone
Request Body schema: application/json
id
integer <int64>
fullName
string
username
required
string [ 3 .. 250 ] characters ^[a-zA-Z0-9._-]{3,}$
password
required
string [ 3 .. 250 ] characters
permissions
required
Array of strings non-empty unique

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "fullName": "string",
  • "username": "string",
  • "password": "string",
  • "permissions": [
    ]
}

Frontend Resource

/api/templates/settings.js

Authorizations:
NoneNone

Responses

Version Resource

Get versions

Get all versions available

Authorizations:
NoneNone
query Parameters
active
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create version

Creates a new version and fires the importing process

Authorizations:
NoneNone

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "2022-03-10",
  • "updatedAt": "2022-03-10",
  • "status": "SCHEDULED",
  • "records": 0,
  • "isActive": true,
  • "active": true
}

Get version

Get version by id

Authorizations:
NoneNone
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "2022-03-10",
  • "updatedAt": "2022-03-10",
  • "status": "SCHEDULED",
  • "records": 0,
  • "isActive": true,
  • "active": true
}

Update version

Update version status

Authorizations:
NoneNone
path Parameters
id
required
integer <int64>
Request Body schema: application/json
id
integer <int64>
createdAt
required
string <date> (Date)
updatedAt
required
string <date> (Date)
status
required
string (Status)
Enum: "SCHEDULED" "DOWNLOADING" "UNZIPPING" "IMPORTING" "INDEXING" "ERROR" "CANCELLED" "COMPLETED" "DELETING" "CANCELLING"
records
required
integer <int32>
triggerKey
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "2022-03-10",
  • "updatedAt": "2022-03-10",
  • "status": "SCHEDULED",
  • "records": 0,
  • "triggerKey": "string",
  • "version": 0
}

Delete version

Delete version by id

Authorizations:
NoneNone
path Parameters
id
required
integer <int64>

Responses

Who Am I Resource

/api/whoami

Authorizations:
NoneNone

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "fullName": "string",
  • "username": "string",
  • "password": "string",
  • "permissions": [
    ]
}