Services/Sync/Server/Archived/0.3/API: Difference between revisions

Jump to navigation Jump to search
Line 129: Line 129:
= Response Codes =
= Response Codes =


'''200 OK''' -- Returned on a successful request. Note that this does not guarantee that the server has done anything - deleting a nonexistent object will return a 200.
'''200 OK''' -- Returned on a successful request. Note that this does not guarantee that the server has done anything - deleting a nonexistent object will return a 200. The request body will contain the data expected from the transaction.


'''400 Bad Request''' -- Will be returned if there was an error in the client's request, such as malformed JSON, a protocol/content mismatch or a missing required field. The response will contain json data that may provide hints as to the problem.
'''400 Bad Request''' -- Will be returned if there was an error in the client's request. Details of the request will be contained in the body code:


'''401 Unauthorized''' -- Username and password do not allow access to the requested URL
{| width="75%" cellpadding="3" align=center
|- style="background-color: #efefef;"
| '''Code'''
| '''Description'''
|- valign="top"
| 1
| Illegal method/protocol
|- valign="top"
| 2
| Incorrect/missing captcha
|- valign="top"
| 3
| Invalid/missing username
|- valign="top"
| 4
| Attempt to overwrite data that can't be overwritted (such as creating a userid that doesn't exist)
| 5
| Userid must match account in path
| 6
| Json parse failure
| 7
| Missing password field
|}


'''404 Not Found''' -- Returned if the user does not exist.


'''503 Service Unavailable''' -- An internal error (storage failure). Please try back again later.
'''401 Unauthorized''' -- Username and password do not allow access to the requested URL.
 
'''404 Not Found''' -- Returned if the user does not exist. Body does not contain anything useful.
 
'''503 Service Unavailable''' -- An internal error (storage failure). Please try back again later. Some explanation may be available in the body.


= Payloads =
= Payloads =
canmove, Confirmed users
1,173

edits

Navigation menu