Resource |
Study.Model |
Method |
GET |
Purpose |
Predict the response for a single prospect for a study |
Client sends … |
Request | GET model-URI?URL-escaped-encoded-specimen |
Header | Host: host |
Header | Date: date |
Header† | Authorization: yosokumo user-identifier:request-digest |
Header (optional) | Accept: content-type(s) |
Header (optional) | Accept-Encoding: content-encoding(s) |
Server returns … |
Success | Code | 200 OK |
Header | Date: date |
Header | Content-Type: content-type |
Header (conditional) | Content-Encoding: content-encoding |
Header (conditional) | Content-Length: content-length |
Header | Content-MD5: content-digest |
Entity | <specimen document> |
Success (empty specimen) | Code | 204 No Content |
Header | Date: date |
• Authorization header malformed |
• Query portion of requested URI not well-formed |
|
Code |
400 Bad Request |
Authorization header missing and referenced study does not have 'public' visibility | Code | 401 Unauthorized |
Header | WWW-Authenticate: yosokumo user:digest |
• Requesting user not recognized |
• Request digest incorrect |
• Requesting user lacks GET model permission for this study |
|
Code |
403 Forbidden |
Requested URI not recognized | Code | 404 Not Found |
• No supported data interchange format listed in Accept header |
• No supported encoding format listed in Accept-Encoding header |
|
Code |
406 Not Acceptable |
Study in stopped state | Code | 409 Conflict |
Request URI contains more than one thousand characters | Code | 414 Request-URI Too Long |
† Not required if referenced study has 'public' visibility.