API - nsanden/jvzoo-rest-api-php GitHub Wiki
Login
Retrieves the user ID based on username and password.
-
URL
/mobile/login
-
Method:
POST -
URL Params
None
-
Data Params
Required:
username=[string]password=[string]device_id=[string] -
Success Response:
-
Code: 200
-
Content:
{ user_id : 12, success: true }
-
Code: 200
-
Error Response:
-
Code: 200
-
Content:
{ success: false }
-
Code: 200
Logout
Logs the user out of the Mobile app and deletes the user's device from Postradamus
-
URL
/mobile/logout
-
Method:
POST -
URL Params
None
-
Data Params
Required:
username=[string]password=[string]device_id=[string] -
Success Response:
-
Code: 200
-
Content:
{ success: true }
-
Code: 200
-
Error Response:
-
Code: 200
-
Content:
{ success: false }
-
Code: 200
Get Status
Retrieves the number of seconds ago the last post was sent, the number of seconds in the future, the next post will be sent, and the device pause status.
-
URL
/mobile/get-status
-
Method:
POST -
URL Params
None
-
Data Params
Required:
username=[string]password=[string]device_id=[string] -
Success Response:
-
Code: 200
-
Content:
{ last : -155, next : 1992, paused : false, success: true }
-
Code: 200
-
Error Response:
-
Code: 200
-
Content:
{ success: false }
-
Code: 200
Pause
Pauses or unpauses the mobile device
-
URL
/mobile/pause
-
Method:
POST -
URL Params
None
-
Data Params
Required:
username=[string]password=[string]device_id=[string]operation=[int] (1=pause, 2=unpause) -
Success Response:
-
Code: 200
-
Content:
{ success: true }
-
Code: 200
-
Error Response:
-
Code: 404 NOT FOUND
-
Content:
{ success: false }
-
Code: 404 NOT FOUND
Send Post
Sends a post manually to the mobile device. Used for the RETRY and SEND NOW features.
-
URL
/mobile/send-post
-
Method:
POST -
URL Params
None
-
Data Params
Required:
username=[string]password=[string]device_id=[string]operation=[int] (1=retry, 2=send now) -
Success Response:
-
Code: 200
-
Content:
{ success: true }
-
Code: 200
-
Error Response:
-
Code: 200
-
Content:
{ success: false }
-
Code: 200