Export Historical Data

URL

https://veriscanonline.com/Export/History?from={from}&to={to}&search={search}&skip={skip}&take={take}

HTTP Verbs

Both GET and POST can be used to make this request

Request Information

.ASPXAUTH cookie must be sent with the request in order to be authenticated

URI (Body) Parameters

Name	Description	Type	Additional information
from	YYYY-MM-DD format	DateTime	Required
to	YYYY-MM-DD format	DateTime	Required
search	Records that have fields that contain this string will be returned	string
skip	Total number of records to skip over, useful when paginating data	int?
take	Total number of records to return	int?

Note

A Maximum of 1000 rows can be returned from a single request

Response Information

Name	Description	Type	Additional information
HistoryItems		Collection of HistoryItem

HistoryItem

Name	Description	Type	Additional information
Id		int
CustomId		string
Scanned		DateTime
ScannedLocal		DateTime
TimeZoneId		string
IDNum		string
FirstName		string
MiddleName		string
LastName		string
ExpDate		int
Address1		string
Address2		string
Address		string
City		string
JurisdictionCode	state	string
PostalCode		string
Country		string
CountryCode		string
Gender		string
DeviceName		string
LocationName		string
Phone		string
Email		string
GroupComment		string
GroupName		string
Tags		string
Comments		string
CompletedSurveys		string	Collection of CompletedSurvey
CustomFieldValues		string	Collection of CustomFieldValue

CompletedSurvey

Name	Description	Type	Additional information
SurveyID		int

CustomFieldValue

Name	Description	Type	Additional information
FieldId		int
CategoryId		int?
CategoryName		string
TypeId		int
TypeName		string
FieldName		string
Value		string
OptionIds		Collection of int

Response Formats

Default

<HistoryLog xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <HistoryItem id="4071544">
    <Scanned>2016-01-12T21:57:23.277</Scanned>
    <IDNum>9999991</IDNum>
    <FirstName>I</FirstName>
    <MiddleName>AM</MiddleName>
    <LastName>SAMPLE</LastName>
    <BirthDate>1980-01-05T06:00:00</BirthDate>
    <ExpDate>2012-05-12T05:00:00</ExpDate>
    <Address>10 HOPE STREET</Address>
    <City>PAWTUCKET</City>
    <JurisdictionCode>RI</JurisdictionCode>
    <PostalCode>02860</PostalCode>
    <Gender>Female</Gender>
    <DeviceName>Alycia's iPhone</DeviceName>
    <LocationName>Demo</LocationName>
    <Phone/>
    <Email/>
    <GroupComment/>
    <GroupName>Banned</GroupName>
    <Tags/>
    <Comments/>  
    <CountryCode>CA</CountryCode>
    <Address1>111 Main St, Toronto, ON</Address1>
    <ScannedLocal>2020-07-29T14:33:35</ScannedLocal>
    <TimeZoneId>Eastern Standard Time</TimeZoneId>
    <CompletedSurveys>
      <SurveyId>49</SurveyId>
      <SurveyId>51</SurveyId>
    </CompletedSurveys>
    <CustomFieldValues>
      <CustomFieldValue>
        <FieldId>25</FieldId>
        <CategoryId>7</CategoryId>
        <CategoryName>Ordering Clinician</CategoryName>
        <TypeId>1</TypeId>
        <TypeName>String</TypeName>
        <FieldName>Device Name</FieldName>
        <Value>John Smitj</Value>
        <OptionIds />
       </CustomFieldValue>
      </CustomFieldValues>
    </HistoryItem>
  <HistoryItem id="4047838">
</HistoryLog>

Accept: application/json

{
  "HistoryItems": [
    {
      "Id": 4071544,
      "Scanned": "/Date(1452657443277)/",
      "IDNum": "9999991",
      "FirstName": "I",
      "MiddleName": "AM",
      "LastName": "SAMPLE",
      "BirthDate": "/Date(315921600000)/",
      "ExpDate": "/Date(1336816800000)/",
      "Address": "10 HOPE STREET",
      "City": "PAWTUCKET",
      "JurisdictionCode": "RI",
      "PostalCode": "02860",
      "Gender": "Female",
      "DeviceName": "Alycia's iPhone",
      "LocationName": "Demo",
      "Phone": "",
      "Email": "",
      "GroupComment": "",
      "GroupName": "Banned",
      "Tags": "",
      "Comments": "",
      "Country": null,
      "CountryCode": "CA",
      "Address1": "10 HOPE STREET",
      "Address2": "",
      "ScannedLocal": "/Date(1596086484000)/",
      "TimeZoneId": "Central Asia Standard Time",
      "CustomId": "1234567890",
      "CompletedSurveys": [],
      "CustomFieldValues": [
      {
            "FieldId": 25,
            "CategoryId": 7,
            "CategoryName": "Ordering Clinician",
            "TypeId": 1,
            "TypeName": "String",
            "FieldName": "Device Name",
            "Value": "John Smitj",
            "OptionIds": []
      }
    }
  ]
}