Authentication, Notifications And Session Management
- Authentication Type: Basic Authentication
- Username/MOBILE_NO and Password/LOGIN_PASSWORD will be passed within requests' header.
- A Valid MOBILE_NO and LOGIN_PASSWORD for an existing user within PARTICIPANTS table must be passed with each API call header.
- LOGIN_PASSWORD must be MD5 hashed in lower charcters before sending to server and it will always be in MD5 wherever used.
- For guests and anonymous Web Service Consumers (Mobile/Desktop apps) access, username = 1 and a predefined password will be used.
- During every app startup (very first-time startup and every app call/startup) AND after success user login, a call of POST ADD DEVICE must be sent to the server with device's unique UDID and a valid token to enable web server sending push notificatoins the mobile device.
- Sessions need not to be expire ever. So, session management and tokens will not be exist.
General Information
- Global Culture: ar-AE
- All returned data will be in JSON format
- To Minimize JSON data size, objects/properties with NULL values will not be serialized within returned JSON data. It's better also for sent JSON data to follow this rule.
- All tables have a single primary key field with an automatically incremented long/big integer values
- All DateTime values got from web service and also sent to it must be at United Arab Emirates' Local Time. Format: yyyy-MM-ddTHH:mm:ss.fffZ Example: 2020-12-25T14:18:28.123Z
- To resize any image to any appropriate width and height you can user ResizeImage API
- POST/PUT/DELETE requests' reply will always consist of: Status + affected Object array of the same type of passed object. Details are explained within each API's help page