search

aodn / aatams

Animal Tracking (formerly AATAMS)
https://aatams.aodn.org.au
8 stars 3 forks source link

XML upload service is not well documented #92

Open jkburges opened 10 years ago

jkburges commented 10 years ago

There needs to be some explanation of the status codes returned and possible error messages, etc. See email to Vemco below...

jkburges commented 10 years ago
What are the possible status codes returned, and would it be appropriate to use the contents of the errMsg field to display an error-specific message to the user?
The status codes returned follow the standard HTTP return codes: briefly, 2xx - Success, 4xx - client error (e.g. invalid parameters passed to the web service), 5xx - server error (e.g. something errored on the server side). The client code probably only needs to check for 2xx success, 4xx client error (in which case it can possibly rectify the situation) or 5xx server error (in which case the client can probably not do a lot). Note that this status code is just the status of the request/response itself, *not* of the processing of the uploaded file (which happens after the response is sent). We will try to keep the errMsg as "user friendly" as possible, so it's up to you guys whether or not to display that to the end users.
How does the percentComplete field work? Could it be used to periodically update a progress indicator within the app?
Percentage complete from 0 - 100 (although it's not being updated in the current implementation - which has probably caused some confusion). It can indeed be used as a progress indicator (just poll repeatedly the URL that the client is redirected to in the response). Also, the "status" attribute will be "PROCESSING", "PROCESSED", or "ERROR". This *is* the status of the actual uploaded file processing.