Configuración
BETA: Esta funcionalidad está en desarrollo y puede que haya cambios no reflejados en esta ayuda.
Esta sección aborda la configuración de los dominios.
GET /domains
Este método devuelve la lista de dominios.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve la lista de dominios.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Request: {"type":"get", "url":"domains", "data":"company=edinn&session=0PY4RhPbK7YW5sbRXiwASrA2HEeCP0eGFzunnfiEJYWrp4whnU11FLESeYpB"} Response: { "status": "0", "data": [ { "Id": "clients", "Desc": "Clientes" }, { "Id": "No", "Desc": "" }, { "Id": "P1", "Desc": "P1" } ], "message": "Success" } |
POST/domains/{id}
Este método crea un dominio. El usuario debe ser administrador.
Atributos requeridos:
- id [obligatorio]: el Id. del dominio.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- description [obligatorio]: la descripción del combo.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: "Success" en caso de éxito, y vacío en caso de error.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Request: {"type":"post", "url":"domains/P5", "data":"company=edinn&session=0PY4RhPbK7YW5sbRXiwASrA2HEeCP0eGFzunnfiEJYWrp4whnU11FLESeYpB&idcomb=test&desc=testcomb"} Response: { "status": 0, "data": true, "message": "Success" } |
PUT/domains/{id}
Este método modifica un combo. El usuario debe ser administrador.
Atributos requeridos:
- id [obligatorio]: el Id. del dominio.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- description [obligatorio]: la descripción del combo.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: "Success" en caso de éxito, y vacío en caso de error.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Request: {"type":"put", "url":"domains/clients", "data":"company=0337182880&session=QYZg8jAUbwaJcfQegBpTuw8GxnRQeWmTBvUT2d2XJMI2okCUgyJsc78efg85&idcomb=No&desc=testcomb"} Response: { "status": 0, "data": true, "message": "Success" } |
DELETE /domains/{id}
Este método elimina un combo. El usuario debe ser administrador.
Atributos requeridos:
- id [obligatorio]: el Id. del dominio.
Parámetros de solicitud (Request parameters):
- company [obligatoria]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: "Success" en caso de éxito, y vacío en caso de error.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Request: {"type":"delete", "url":"domains/clients", "data":"company=0337182880&session=QYZg8jAUbwaJcfQegBpTuw8GxnRQeWmTBvUT2d2XJMI2okCUgyJsc78efg85"} Response: { "status": 0, "data": true, "message": "Success" } |