Módulo API
api/mkt/segmento
...
getlist
____
https://restelix.com/api/mkt/segmento/getlist
Request:
numpagina |
Opcional. Página actual. Default: 0 |
renglonespagina |
Opcional. Renglones por página. Default: 20 |
orden |
Opcional. Campo(s) para ordenar la lista (Ej: fecha:A) |
fields |
Opcional. Lista de campos a incluir en lista (separados por coma) |
nombre |
Filtro opcional |
st |
Filtro opcional |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
Descripción del Status |
numregistros |
Número total de registros |
numpaginas |
Número de páginas en base a renglonespagina |
numpagina |
Número de página actual |
renglonespagina |
Número de renglones por página |
lista |
Arreglo de registros que cumplen con los filtros |
fields |
Arreglo de los campos incluidos en la lista |
filtro |
Arreglo asociativo campo:valor de los filtros aplicados |
orden |
Campo(s) empleados para ordenar de la lista |
Campos de lista
:
id |
|
nombre |
|
st |
|
status |
|
campo1 |
|
op1 |
|
operador1 |
|
valor1 |
|
campo2 |
|
op2 |
|
operador2 |
|
valor2 |
|
campo3 |
|
op3 |
|
operador3 |
|
valor3 |
|
campo4 |
|
op4 |
|
operador4 |
|
valor4 |
|
campo5 |
|
op5 |
|
operador5 |
|
valor5 |
|
campo6 |
|
op6 |
|
operador6 |
|
valor6 |
get
____
https://restelix.com/api/mkt/segmento/get
Request:
id |
ID del objeto |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
master |
Campos de master
:
id |
|
nombre |
|
st |
|
campo1 |
|
op1 |
|
valor1 |
|
campo2 |
|
op2 |
|
valor2 |
|
campo3 |
|
op3 |
|
valor3 |
|
campo4 |
|
op4 |
|
valor4 |
|
campo5 |
|
op5 |
|
valor5 |
|
campo6 |
|
op6 |
|
valor6 |
|
status |
|
operador1 |
|
operador2 |
|
operador3 |
|
operador4 |
|
operador5 |
|
operador6 |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
create
____
https://restelix.com/api/mkt/segmento/create
Request:
master |
Valores de las propiedades del nuevo objeto |
Campos para master
:
nombre |
|
st |
|
campo1 |
|
op1 |
|
valor1 |
|
campo2 |
|
op2 |
|
valor2 |
|
campo3 |
|
op3 |
|
valor3 |
|
campo4 |
|
op4 |
|
valor4 |
|
campo5 |
|
op5 |
|
valor5 |
|
campo6 |
|
op6 |
|
valor6 |
|
status |
|
operador1 |
|
operador2 |
|
operador3 |
|
operador4 |
|
operador5 |
|
operador6 |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
id |
ID del objeto creado |
Status de Respuesta:
001 |
OK |
C099 |
Error en los datos. Regresa el arreglo 'err' con la lista de errores |
update
____
https://restelix.com/api/mkt/segmento/update
Request:
id |
ID del objeto a actualizar |
master |
Valores de las propiedades del objeto |
Campos para master
:
nombre |
|
st |
|
campo1 |
|
op1 |
|
valor1 |
|
campo2 |
|
op2 |
|
valor2 |
|
campo3 |
|
op3 |
|
valor3 |
|
campo4 |
|
op4 |
|
valor4 |
|
campo5 |
|
op5 |
|
valor5 |
|
campo6 |
|
op6 |
|
valor6 |
|
status |
|
operador1 |
|
operador2 |
|
operador3 |
|
operador4 |
|
operador5 |
|
operador6 |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
id |
ID del objeto creado |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
C099 |
Error en los datos. Regresa el arreglo 'err' con la lista de errores |
delete
____
https://restelix.com/api/mkt/segmento/delete
Request:
id |
ID del objeto a borrar |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
C023 |
Existen registros asociados |