Field Hub - Summary
When accessing /FieldHubs
URI via GET, the Slingshot API Server will return a Slingshot Index document that contains the summary data of all Field Hubs that are assigned to the Access Key contained in the request headers. This data will contain URI values that point to the details for each Field Hub in the list.
HTTP Method and URL
GET https://api.ravenslingshot.com/fieldhubs
URL Parameters
None.
HTTP Query Parameters
To learn more about these parameters, read about Result Set Paging.
Parameter | Description |
---|---|
pagesize | [Optional] Number of rows to return for a result page. |
page | [Optional] Specific result page to return. |
HTTP Headers
To learn more about these parameters, read about Authentication.
Header | Description |
---|---|
X-SS-AccessKey | [Required] Token issued to a Slingshot user from the Raven Slingshot Portal Server. |
X-SS-APIKey | [Required] Token issued to the Slingshot developer from Raven. |
X-SS-Signature | [Required] The signature generated for a specific request. |
X-SS-TimeStamp | [Required] The timestamp of when the request was generated. |
Sample Responses
XML
<!--?xml version="1.0" encoding="UTF-8"?-->
<slingshotindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.ravenslingshot.com/SlingshotIndex/2010">
<fieldhub>
<id>09613471299</id>
<name>18March2013</name>
<uri>https://api.ravenslingshot.com/FieldHubs/09613471299</uri>
</fieldhub>
<fieldhub>
<id>352974026203117</id>
<name>Jack ICE ATT</name>
<uri>https://api.ravenslingshot.com/FieldHubs/352974026203117</uri>
</fieldhub>
<totalcount>2</totalcount>
<pagesize>20</pagesize>
<pageindex>0</pageindex>
<totalpages>1</totalpages>
<ispreviouspage>false</ispreviouspage>
<isnextpage>false</isnextpage>
</slingshotindex>
JSON
{
"FieldHub": [
{
"ID": "09613471299",
"Name": "18March2013",
"Uri": "https://api.ravenslingshot.com/FieldHubs/09613471299"
},
{
"ID": "352974026203117",
"Name": "Jack ICE ATT",
"Uri": "https://api.ravenslingshot.com/FieldHubs/352974026203117"
}
],
"TotalCount": 2,
"PageSize": 20,
"PageIndex": 0,
"TotalPages": 1,
"IsPreviousPage": false,
"IsNextPage": false
}