Confirmed users
169
edits
Services/F1/Server/API: Difference between revisions
→GET /response
Tarek.ziade (talk | contribs) |
Mixedpuppy (talk | contribs) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
* Portable Contacts. All profile or contact data is in Portable Contacts format. | * Portable Contacts. All profile or contact data is in Portable Contacts format. | ||
=== X-Target-Domain === | |||
All APIs must be called with a X-Target-Domain header. The header contains the name of the domain that is being called through the server. This header is used by the server to determine if the service for the domain is available or not. | |||
If the domain is not available, the client will immediately receive a 503 with a Retry-After header, the value will be the number of seconds to wait before retrying. The [http://www.freesoft.org/CIE/RFC/2068/201.htm RFC for Retry-After] also allows for a timestamp, but the server will be sending a number that represents seconds. | |||
The client will then need to wait for that time before retrying. In the interim, the client is allowed to call the server for other services. | |||
=== Security === | === Security === | ||
| Line 62: | Line 70: | ||
=== OAuth APIs === | === OAuth APIs === | ||
==== Request and Response bodies ==== | ==== Request and Response bodies ==== | ||
| Line 156: | Line 155: | ||
==== GET /response ==== | ==== GET /response ==== | ||
[NOT IMPLEMENTED] | |||
The response api is used to retrieve responses to other api calls. | The response api is used to retrieve responses to other api calls. | ||