GET v1/results/download?serviceprovider={serviceprovider}&mode={mode}&limit={limit}

Get Results: Retrieve results provided by a service provider not downloaded before.

Request Information

URI Parameters

Name	Description	Type	Additional information
serviceprovider	Name of service provider associated with the results. If empty or not supplied, results for all service providers in this organization are retrieved.	string	Default value is
mode	Determines whether the results retrieved are test mode or live (aka production) mode results. Specify 'live' to retrieve live results. If empty or any other value, only test mode results are retrieved.	string	Default value is
limit	Limits the number of results retrieved. If not supplied or 0, all results ready for download will be retrieved.	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

ResultsDownloadBaseResponse

Name	Description	Type	Additional information
ResultList	List of results objects	Collection of Result	None.
BatchIDs	Batch IDs for use in confirming result download	string	None.
Error	Will be set to True if any errors occur during the processing of the API method.	boolean	None.
ErrorMessage	Will contain an error message string if Error is True.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultList": [
    {
      "HL7Document": {
        "Data": "sample string 1",
        "Type": "sample string 2"
      },
      "ResultURL": "sample string 1",
      "PDFDocuments": [
        {
          "Data": "sample string 1",
          "Type": "sample string 2"
        },
        {
          "Data": "sample string 1",
          "Type": "sample string 2"
        }
      ],
      "ResultID": 2,
      "DOB": "sample string 3",
      "LastName": "sample string 4",
      "FirstName": "sample string 5",
      "PatientID": "sample string 6",
      "TransmitID": "sample string 7",
      "ControlID": "sample string 8",
      "ProviderLastName": "sample string 9",
      "ProviderFirstName": "sample string 10",
      "ProviderNPI": "sample string 11",
      "ProviderUPIN": "sample string 12"
    },
    {
      "HL7Document": {
        "Data": "sample string 1",
        "Type": "sample string 2"
      },
      "ResultURL": "sample string 1",
      "PDFDocuments": [
        {
          "Data": "sample string 1",
          "Type": "sample string 2"
        },
        {
          "Data": "sample string 1",
          "Type": "sample string 2"
        }
      ],
      "ResultID": 2,
      "DOB": "sample string 3",
      "LastName": "sample string 4",
      "FirstName": "sample string 5",
      "PatientID": "sample string 6",
      "TransmitID": "sample string 7",
      "ControlID": "sample string 8",
      "ProviderLastName": "sample string 9",
      "ProviderFirstName": "sample string 10",
      "ProviderNPI": "sample string 11",
      "ProviderUPIN": "sample string 12"
    }
  ],
  "BatchIDs": "sample string 1",
  "Error": true,
  "ErrorMessage": "sample string 3"
}

application/xml, text/xml

Sample:

<ResultsDownloadBaseResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>true</Error>
  <ErrorMessage>sample string 3</ErrorMessage>
  <ResultList>
    <Result>
      <HL7Document>
        <Data>sample string 1</Data>
        <Type>sample string 2</Type>
      </HL7Document>
      <ResultURL>sample string 1</ResultURL>
      <PDFDocuments>
        <ResultDocument>
          <Data>sample string 1</Data>
          <Type>sample string 2</Type>
        </ResultDocument>
        <ResultDocument>
          <Data>sample string 1</Data>
          <Type>sample string 2</Type>
        </ResultDocument>
      </PDFDocuments>
      <ResultID>2</ResultID>
      <DOB>sample string 3</DOB>
      <LastName>sample string 4</LastName>
      <FirstName>sample string 5</FirstName>
      <PatientID>sample string 6</PatientID>
      <TransmitID>sample string 7</TransmitID>
      <ControlID>sample string 8</ControlID>
      <ProviderLastName>sample string 9</ProviderLastName>
      <ProviderFirstName>sample string 10</ProviderFirstName>
      <ProviderNPI>sample string 11</ProviderNPI>
      <ProviderUPIN>sample string 12</ProviderUPIN>
    </Result>
    <Result>
      <HL7Document>
        <Data>sample string 1</Data>
        <Type>sample string 2</Type>
      </HL7Document>
      <ResultURL>sample string 1</ResultURL>
      <PDFDocuments>
        <ResultDocument>
          <Data>sample string 1</Data>
          <Type>sample string 2</Type>
        </ResultDocument>
        <ResultDocument>
          <Data>sample string 1</Data>
          <Type>sample string 2</Type>
        </ResultDocument>
      </PDFDocuments>
      <ResultID>2</ResultID>
      <DOB>sample string 3</DOB>
      <LastName>sample string 4</LastName>
      <FirstName>sample string 5</FirstName>
      <PatientID>sample string 6</PatientID>
      <TransmitID>sample string 7</TransmitID>
      <ControlID>sample string 8</ControlID>
      <ProviderLastName>sample string 9</ProviderLastName>
      <ProviderFirstName>sample string 10</ProviderFirstName>
      <ProviderNPI>sample string 11</ProviderNPI>
      <ProviderUPIN>sample string 12</ProviderUPIN>
    </Result>
  </ResultList>
  <BatchIDs>sample string 1</BatchIDs>
</ResultsDownloadBaseResponse>