Skip to main content

Prescription Maps - Detail

When accessing /PrescriptionMaps/{id} via GET, the Slingshot API Server will respond with a XML/json document that contains the details of the file.

If the request has a query parameter format for example /PrescriptionMaps/{id}?format=bin then the API will respond with a zip file that contains the details of the Prescription Map identified by {id} and the format indicated by the format query string parameter. The AgX format is not supported and the RAD format cannot be downloaded any more.

HTTP Method and URL​

GET https://api.ravenslingshot.com/prescriptionmaps/:id

URL Parameters​

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

HTTP Query Parameters​

None.

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.

Sample Responses​

XML​

<!--?xml version="1.0" encoding="utf-8"?-->
<prescriptionmapdetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.ravenslingshot.com/PrescriptionMapDetail/2010">
<devicefilename>Roundup.zip</devicefilename>
<createdate>2013-04-30T19:54:01.873Z</createdate>
<updatedate>2013-04-30T19:54:39.057Z</updatedate>
<status>SENT_TO_DEVICE</status>
<jobtype>PrescriptionMap</jobtype>
<availablefiles>
<file>
<filename>Roundup.zip</filename>
<uri>https://api.ravenslingshot.com/PrescriptionMaps/8750738?format=bin</uri>
<filetype>bin</filetype>
</file>
</availablefiles>
</prescriptionmapdetail>

JSON​

{
"DeviceFileName": "Roundup.zip",
"CreateDate": "2013-04-30T19:54:01.873Z",
"UpdateDate": "2013-04-30T19:54:39.057Z",
"Status": "SENT_TO_DEVICE",
"JobType": "PrescriptionMap",
"AvailableFiles": [
{
"FileName": "Roundup.zip",
"Uri": "https://api.ravenslingshot.com/PrescriptionMaps/8750738?format=bin",
"FileType": "bin"
}
]
}