API's - Enterprise Service Platform

32 min

Esta sección pretende describir el marco de comunicación REST, establecida entre las aplicaciones y el servidor back-end.

⚠️¡Atención!

4biz_URL: prefijo de URL inmutable, para que pueda acceder a los servicios disponibles para aplicaciones móviles. Cada API que necesite un "sessionID" deberá estar en una sesión proporcionada por el "Inicio de sesión" de la API.

Inicio de sesión

Inicio de sesión del usuário para utilizar los Servicios 4biz:

POST

Response {
	"sessionID": "2355A68BF75281B73607EEC1A7191645",
	"rangeAction": 10,
	"locationInterval": 10
	}

ListContracts

Lista de contratos accesibles para el asistente.

POST

	{
	"dateTime": 1412101947000,
	"operationID": 65,
	"error": null,
	"contracts": [
	{
	"id": 1,
	"description": "Test Name"
	}
	]
	}

ListDeniedReasons

Lista de razones para rechazar una solicitud, por ejemplo, en el check-in:

	{
	"sessionID": "2355A68BF75281B73607EEC1A7191645"
	}

	Solicitación :
		sessionID: alfanumérico no nulo y no vacío;
	Respuesta :
		dateTime: timestamp no vacío ni nulo;
		operationID: numérico no vacío ni nulo;
		error: valor alfanumérico que puede ser nulo pero no vacío;
		contracts: no vacío ni nulo;
		id: numérico no vacío ni nulo;
		description: alfanumérico no vacío ni nulo.

ListSolicitationStatus

Enumera los estados de una solicitud que se utilizará, por ejemplo, en el servicio de checkout.

	{
	"sessionID": "2355A68BF75281B73607EEC1A7191645"
	}

	Solicitación :
		sessionID: alfanumérico no vacío y no nulo;
	Respuesta :
		dateTime: timestamp no vacío ni nulo;
		operationID: numérico no vacío ni nulo;
		error: valor alfanumérico que puede ser nulo pero no vacío;
		contracts: no vacío ni nulo;
		id: numérico no vacío ni nulo;
		description: alfanumérico no vacío ni nulo.

ListUnits

Enumera las unidades de un contrato:

	{
	"sessionID": "2355A68BF75281B73607EEC1A7191645"
	"contractID": 1233
	}

	{
	"dateTime": 1412101988000,
	"operationID": 66,
	"error": null,
	"units": [
	{
	"id": 1,
	"description": "Default"
	},
	{
	"id": 2,
	"description": "Unit Test"
	}
	]
	}

SendCoordinates

Actualiza las coordenadas geográficas de una unidad.

POST

	Solicitación:
		unitID: numérico no nulo;
		sessionID: alfanumérico no vacío ni nulo;
		latitude: numérico no nulo;
		longitude: numérico no nulo;
	Respuesta:
		dateTime: timestamp no vacío ni nulo;
		operationID: numérico no vacío ni nulo;
		error: valor alfanumérico que puede ser nulo pero no vacío;
		success: boolean;

DeviceDisassociate

Desvincular un usuario de un dispositivo para que, al eliminar una conexión, el usuario deje de recibir la notificación push de la conexión eliminada.

POST

	{
	"dateTime": 1412102841000,
	"operationID": 68,
	"error": null,
	"success": true
	}

GetNewest

Recupera la solicitud más reciente del usuario en el grupo a partir de la última (newestNumber) en la aplicación.

POST

	{
	"dateTime": 1377618318000,
	"operationID": 336,
	"error": null,
	"notifications": [
	{
	"number": 95933,
	"taskId": 22737,
	"type": 1,
	"date": "27/08/2013",
	"timeFlag": 12345,
	"timeSLA": 12,
	"latitude": 32.9984730,
	"longitude": 29.9984730,
	"endSLA": "null",
	"task": "Validar requisição",
	"personal": true,
	"inService": true,
	"inCkeckin": 0,
	"typeRequest": 0,
	"waiting": 1,
	"service": "SERVICES AND PRODUCTS REQUEST",
	"contract": 1,
	"unit": 15,
	"priorityorder": 1
	}
	]
	}

GetOldest

Recupera la solicitud más reciente del usuario en el grupo a partir de la más antigua.

	{
	"notificationType": 0,
	"onlyApproval": 1,
	"oldestNumber": 322,
	"sessionID": "2355A68BF75281B73607EEC1A7191645"
	}

	{
	"dateTime": 1377618318000,
	"operationID": 336,
	"error": null,
	"notifications": [
	{
	"number": 95933,
	"taskId": 22737,
	"type": 1,
	"date": "27/08/2013",
	"timeFlag": 12345,
	"timeSLA": 12,
	"latitude": 32.9984730,
	"longitude": 29.9984730,
	"endSLA": "null",
	"task": "Validate request",
	"personal": true,
	"inService": true,
	"inCheckin": 1,
	"typeRequest": 0,
	"waiting": 1
	"service": "SERVICES AND PRODUCTS REQUEST",
	"contract": 1,
	"unit": 15,
	"priorityorder": 1
	}
	]
	}

GetByCoordinates

Recupera la solicitud más reciente del usuario en el grupo desde las coordenadas actuales del usuario.

POST

	{
	"dateTime": 1377618318000,
	"operationID": 336,
	"error": null,
	"notifications": [
	{
	"number": 95933,
	"taskId": 22737,
	"type": 1,
	"date": "27/08/2013",
	"timeFlag": 12345,
	"timeSLA": 12,
	"latitude": 32.9984730,
	"longitude": 29.9984730,
	"endSLA": "null",
	"task": "Validate request",
	"typeRequest": 0,
	"waiting": 1
	"personal": true,
	"inService": true,
	"inCheckin": 1,
	"service": "SERVICES AND PRODUCTS REQUEST",
	"contract": 1,
	"unit": 15,
	"priorityorder": 1
	}
	],
	"paging": {
	"page": 1,
	"size": 1,
	"totalElements": 5,
	"totalPages": 5
	}
	}

UpdateNotification

Recupera las tareas de un servicio.

	{
	"dateTime": 1377618318000,
	"operationID": 336,
	"error": null,
	"notifications": [
	{
	"number": 95933,
	"taskId": 22737,
	"type": 1,
	"date": "27/08/2013",
	"timeFlag": 12345,
	"timeSLA": 12,
	"latitude": 32.9984730,
	"longitude": 29.9984730,
	"endSLA": "null",
	"task": "Validate request",
	"personal": true,
	"inService": true,
	"inCheckin": 1,
	"typeRequest": 0,
	"waiting": 1
	"service: "SERVICES AND PRODUCTS REQUEST",
	"contract": 1,
	"unit": 15,
	"priorityorder": 1
	}
	]
	}

POST

GetById

Recupera los detalles de una solicitud, de acuerdo con su identificador.

POST

	{
	"dateTime": 1377618392000,
	"operationID": 337,
	"error": null,
	"notification": {
	"endSLA": "null",
	"task": "Validate request",
	"service": "SERVICES AND PRODUCTS REQUEST",
	"description": " test",
	"status": "In progress",
	"taskStatus": "Available",
	"timeSLA": 12
	}
	}

GetReasons

Recuperar os motivos a serem utilizados na aprovação de uma solicitação, de acordo com a solicitação.

POST

	{
	"dateTime": 1377618482000,
	"operationID": 339,
	"error": null,
	"amount": 4,
	"reasons": [
	{
	"id": 1,
	"desc": "Non-refundable authorization"
	},
	{
	"id": 4,
	"desc": "Purchase necessary to the business"
	},
	{
	"id": 6,
	"desc": "Purchase need supplied with another solution"
	},
	{
	"id": 5,
	"desc": "Value of quotation above the budget of the contract"
	}
	]
	}

AttendRequest

Informar el inicio de la atención de una solicitud de servicio.

POST

	{
	"dateTime": 1377618517000,
	"operationID": 341,
	"error": null,
	"success": true
	}

AttendantLocation

Informa la ubicación automática de la posición del asistente.

POST

	{
	"dateTime": 1412102841000,
	"operationID": 68,
	"error": null,
	"success": true
	}

Feedback

Registra la aprobación o denegación de una solicitud de servicio.

POST

	{
	"dateTime": 1377618517000,
	"operationID": 341,
	"error": null
	}

New

Cree una nueva solicitud.

POST

	{
	"dateTime": 1377618543000,
	"operationID": 342,
	"error": null,
	"number": 95935
	}

Check-In

Check-in del asistente en una solicitud. En otras palabras, inicia el cumplimiento de la solicitud.

	{
	"taskId": 22778,
	"sessionID": "2355A68BF75281B73607EEC1A7191645",
	"latitude": -19.369852147,
	"longitude": -49.369852147,
	"startTime": 1377618543000
	}

	{
	"dateTime": 1377618543000,
	"operationID": 342,
	"error": null,
	"number": 95935
	}

Check-Out

Comprueba un asistente en una solicitud, actualizando su estado ("Suspendido", "Resuelto", etc.).

POST

	{
	"dateTime": 1377618517000,
	"operationID": 342,
	"error": null,
	"number": 95935
	}

Check-InDenied

Registrar la denegación de una solicitud de servicio por parte del asistente, en los casos de rechazo al check-in.

POST

	{
	"dateTime": 1377618543000,
	"operationID": 342,
	"error": null
	}