Prescription Maps - Upload
When accessing /PrescriptionMaps
via POST, if the FileType is 'RX' the Slingshot API Server will expect the request body to consist of a compressed container (a ZIP file) that contains a single shape file presented as _.shp, _.shx, *.dbf. Complex file with multiple shape files zipped into a single archive is not supported by the API. If the FileType is AGX then the file can either be a simple or complex file and must have .rdp.zip extension.
Queuing prescription maps or recommendations with the same name to a legacy device (Envizio Pro or Viper Pro) will fail and only the first file will transfer. Sending a file to a legacy device that already contains a file with the same name will cause the file to be overwritten.
The request body should be encoded using multipart/form-data standards with the following entry defined:
- FileName: this entry will contain the file contents as well as the name of the file
- FileType: this entry will indicate the type of data contained in the ZIP file, e.g. "AGX" or "RX"
If successful, the Slingshot API Server will respond with a HTTP 201 Created message and the URI of the newly created Prescription Map. The returned URI can be used to retrieve the details of the Prescription Map.
HTTP Method and URL
POST https://api.ravenslingshot.com/prescriptionmaps
URL Parameters
None.
HTTP Query Parameters
None.
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
HTTP
User-Agent: Mozilla/5.0 (Windows NT 6.2; WOW64; rv:19.0) Gecko/20100101 Firefox/19.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-US,en;q=0.5
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Type: multipart/form-data; boundary=---------------------------12217651423230
Content-Length: 40351
-----------------------------12217651423230
Content-Disposition: form-data; name="FileName"; filename="SampleRxMap.zip"
Content-Type: application/zip
PK(rest of ZIP file contents)