API´s ESP -Enterprise Service Platform
This section is intended to describe the communication structure REST, established between applications and the back-end server.
"CITSMART_URL": URL unalterable prefix, so that you can access the services made available to the mobile applications. ALL API THAT REQUIRES A “sessionID” WILL NEED TO BE IN A SESSION PROVIDED BY THE “Login” API.
Login
"Login the user to use CITSmart Services."
POSTListContracts
List the contracts accessible to the attendant."
POSTListDeniedReasons
List the reasons when refusing a request, like in the check-in."
POSTListSolicitationStatus
List status of a request to be used, for example, in the checkout service."
POSTListUnits
List the units of a contract"
POSTSendCoordinates
Update the geographical coordinates of a unit."
POSTDeviceDisassociate
Disassociate a user from a device, so that when a user deletes a connection, the user no longer receives push notification from the deleted connection."
POSTGetNewest
Recover the most recent request for the user in the group, from the latest (newestNumber) in the App "
POSTGetOldest
Recover the most recent request for the user in the group, from the oldest."
POSTGetByCoordinates
Recover the most recent request for the user in the group, from the user's current coordinates."
POSTUpdateNotification
Retrieve the tasks of a service."
POSTGetById
Retrieves details of a request, according to its identifier"
POSTGetReasons
Recover motives to be used in the approval of a request, according to the request."
POSTAttendRequest
Inform the beginning of attendance of a service request "
POSTAttendantLocation
Reports the automatic location of the attendant position."
POSTFeedback
Register an approval or denial of a service request."
POSTNew
Create a new request."
POSTCheck-In
Check-in of the attendant in a request. In other words, it initiates the fulfillment of the request."
POSTCheck-Out
Checks out an attendant in a request, updating their status ("Suspended", "Solved", etc.)."
POSTCheck-InDenied
Register the denial of a request attendance by the attendant, in cases of refusal to the check-in. "
POST