Metodo: newService

Crea un servicio o si se envía un servicio de referencia lo actualiza, tendrá como resultado el servicio creado o actualizado.

Parámetros Descripción Tipo de Dato
user * Nombre de usuario del sistema String
 password   * Contraseña del usuario String
action * newService String
serviceRef * Referencia única, obligatoria para la parte 0 Integer
Priority * Prioridad del envió (1,2,3,4) defecto 1 ( 1: Entrega directa 2: Entrega menos de 1 hora 3: Entrega menos de 2 hora 4: Entrega planificada ) Integer
serviceRefExtension * La parte del pedido 0,1,2,3,4... Integer
serviceType * Tipo de servicio ( 1. Entrega 2. Recogida ) Integer
 address * Dirección de donde se debe ir, formato nombre de la calle, numero, código postal, ciudad ejemplo: Calle Gran Vía, 20, 28013 Madrid; o también se puede enviar la geoposición ejemplo: 40.419962,-3.700081 String
addressExtraInfo * Si necesita alguna información adicional String
customerName * Nombre del cliente por el que se debe preguntar String
customerPhone * Teléfono donde contactar al cliente String
 comments * Comentarios sobre el pedido String
 startTime * Hora planificada de llegada al sitio (Y-m-d H:i) DataTime
Ejemplo del API: Ejemplo
{"erro":false,"mens":"Ok","status":true,"message":"success","serviceRef":"ZRQ2LIRQFT","serviceRefExtension":"1","serviceTime":"2017-01-18 03:09:57"}

Metodo: serviceDetails

Consultar detalle de los servicios creados por el usuario

Parámetros Descripción Tipo de Dato
user * Nombre de usuario del sistema String
password * Contraseña del usuario String
action * serviceDetails String
serviceRef * Referencia única String
serviceRefExtension * Si no se manda información devolverá todos los detalles del pedido. Integer
Ejemplo del API: Ejemplo
{"erro":false,"mens":"Ok","serviceRef":"N9XGDJCWHX","vehicleId":"65","vehicle":"MAD - Adri\u00e1n Cerrato","vehicleLatitude":"40.43908","vehicleLongitude":"-3.71289","serviceDetails":[{"serviceRefExtension":"0","serviceLatitude":"40.4349627","serviceLongitude":"-3.7144754","scheduledTime":"2017-01-23 10:40:35","displayEndTime":"2017-01-23 10:36:27","status":"Completed","photoURL":null,"signatureURL":"https:\/\/s3-eu-west-1.amazonaws.com\/speedmspbucket001\/ServiceFiles\/Signatures\/3506990_sgn_1891682389.jpg"},{"serviceRefExtension":"1","serviceLatitude":"40.4622962","serviceLongitude":"-3.7021926","scheduledTime":"2017-01-23 11:05:35","displayEndTime":null,"status":"Started","photoURL":null,"signatureURL":null}]}

Metodo: getVehiclePosition

Consultar ubicación del vehículo que lleva el pedido del usuario

Parámetros Descripción Tipo de Dato
user * Nombre de usuario del sistema. String
password * Contraseña del usuario. String
action * getVehiclePosition String
vehicleId * Código del vehiculo que se desea consultar. Integer
Ejemplo del API: Ejemplo
{"erro":false,"mens":"Ok","vehicleId":"85","vehicle":"CAT24","vehicleLatitude":"41.39419","vehicleLongitude":"2.17439"}

Notificaciones PUSH

Nuestro sistema permite enviarle notificaciones PUSH a nuestros clientes, para que tengan la información actualizada en los momentos precisos, para eso se debe de proveer un sistema que permita notificarlo.

Parámetros Descripción Tipo de Dato
serviceRef * Referencia única. Integer
serviceRefExtension * La parte del pedido 0,1,2,3,4... Integer
status * El estado al que cambia el pedido: Leido, Comenzado, Completo. String
date  * Fecha y hora en la que se realiza el cambio. DateTime