Skip to main content

Job Data - Detail

When accessing /JobData/{id} via GET, the Slingshot API Server will respond with the Job Data details in XML/JSON format. This same call will respond with binary a file if the query string has format parameter like /JobData/{id}?format=bin. The value of the parameter controls the format of the returned data.

The available formats are:

  • BIN: The original As Applied zip file as the Field Computer produced it
  • SHP: A zip file containing the shape files representing the As Applied data
  • FMIS: A zip file containing extended XML and TAB suitable for Farm Manage Information Systems software

If the job did not contain any coverage the server will respond with 200 OK response containing the following:

<!--?xml version="1.0"?-->
<slingshotresponse xmlns="http://schemas.ravenslingshot.com/SlingshotResponse/2010">
<status>NO_COVERAGE</status>
<errorinfo>No coverage available.</errorinfo>
<result>nil</result>
</slingshotresponse>

If the conversion failed the errorInfo tag will contain a description of why the conversion failed. If the file format requested is not yet available, the server will respond with 200 OK response containing the following:

<!--?xml version="1.0"?-->
<slingshotresponse xmlns="http://schemas.ravenslingshot.com/SlingshotResponse/2010">
<status>MORE_TIME_NEEDED</status>
<errorinfo>00:00:30</errorinfo>
<result>
</result>
</slingshotresponse>

The value in the tag is a time span value that the API client should wait before attempting to re-request the file.

HTTP Method and URL

GET https://api.ravenslingshot.com/jobdata/{id}

URL Parameters

ParameterDescription
idThe {id} portion of the URI is taken from the XML Document returned by a GET request to the /JobData URI.

HTTP Query Parameters

To learn more about these parameters, read about Result Set Paging.

ParameterDescription
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.

HeaderDescription
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.