Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 2 Current »

Comprobaciones

Para poder ejecutar la operación, se debe comprobar que:

  • La sesión sea válida. La sesión es válida si está activa, lo que implica que se inició sesión con un usuario existente en Colppy.

  • El usuario tenga permisos sobre la empresa.

  • Se deben completar los parámetros:

    • idEmpresa : número entero que corresponde al id de la empresa para la cual impactará la operación.

    • idPriceList : número entero que corresponde al id de la lista de precios que se va a editar.
    • description : nueva descripción para la lista de precios.

    • default_currency_id : identificador que corresponde a la moneda de la lista de precios. Por ejemplo, 3 Pesos, 1 Dólares, 2 Euros.

    • is_disabled : dato para habilitar o deshabilitar la lista de precios. Utilizar 0 si la lista de precios debe ser habilitada o activa, utilizar 1 si la lista de precios debe ser des-habilitada o inactiva.

Operación para editar una Lista de Precios

Solicitud editar_pricelist
{
	"auth": {
		"usuario": "USUARIO_API", //Ingresar el usuario dado de alta en dev.colppy.com
        "password": "USUARIO_API_PASSWORD" //Contraseña en MD5 de usuario de dev.colppy.com
	},
	"service": {
		"provision": "PriceList",
		"operacion": "alta_pricelist"
	},
	"parameters": {
		"sesion": {
			"usuario":  "USUARIO_EMPRESA", //Ingresar el usuario que tiene acceso a la empresa en Colppy
            "claveSesion": "USUARIO_SESION_EMPRESA" // Ingresar la clave devuelta por la operación iniciar_sesion
		},
		"idEmpresa": 131168995,
        "idPriceList": 14615,
        "description": "Lista de Precios en Pesos nueva descripción",
        "default_currency_id": 3,
        "is_disabled": 0
	}
}

Respuesta (éxito) 

Respuesta editar_pricelist
{
    "service": {
        "provision": "PriceList",
        "operacion": "editar_pricelist",
        "version": "1_0_0_0",
        "response_date": "2020-06-22 01:36:51"
    },
    "result": {
        "estado": 0,
        "mensaje": "La operación se realizó correctamente"
    },
    "response": {
        "success": true,
        "message": "La operación se realizó con éxito.",
        "data": {
            "success": true,
            "code": 200,
            "message": "OK",
            "data": {
                "id": 14617,
                "company_id": 131168995,
                "description": "Lista de Precios en Pesos nueva descripción",
                "default_currency_id": 3,
                "is_disabled": 0,
                "created_at": "2020-06-22 01:19:02",
                "updated_at": "2020-06-22 01:36:46",
                "deleted_at": null
            }
        }
    }
}


Mensajes de Error

Si hay un problema con la petición/request, el result pueden devolver los siguientes códigos de error:

  • "estado" : 501, "mensaje" : "Los datos enviados no corresponden a un valor JSON válido"

Validaciones

Si se pudo ejecutar la petición, pero hay problemas con los datos, el response va a indicar "success" : false, y los siguientes mensajes:

  • "La empresa 123456 no pertenece al usuario USR_COLPPY." Este error indica que falta completar el idEmpresa o que la empresa no pertenece al usuario.

  • "El campo default currency id es obligatorio <br /> La moneda seleccionada no corresponde a esta empresa." Este error indica que no se completó el campo default_currency_id o que la moneda no es un id de moneda válido.
  • "El campo Nombre es obligatorio." Este error indica que el campo description es obligatorio y no fue completado.
  • "El elemento description ya está en uso." Este error indica que ya existe una lista de precios con esa descripción.
  • "El campo is_disabled es obligatorio." Este error indica que el campo is_disabled es obligatorio y no fue completado.


  • No labels