Auto Finance
Articles
Introduction
Welcome to the DRNSights API documentation.
The DRNSights API allows you to manage portfolios of vehicles in a programmatic way using conventional HTTP requests. The endpoints allow you to make calls to retrieve information or to execute actions efficiently.
All of the functionality that you are familiar with in the DRN web UI is also available through the API, allowing you to script the complex actions that your situation requires.
The API documentation will start with a general overview of the design and technology that has been implemented, followed by reference information about specific endpoints.
Requests
All API URLs referenced in this documentation start with the following base part:
https://platform.drndata.com/api
Followed by the name of the API you are targeting:
https://platform.drndata.com/api/AddressScoring
Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URL. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required.
Method | Usage |
---|---|
GET | For simple retrieval of information, you should use the GET method. The server will return the information you request as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying. |
POST | To run an action, your request should specify the POST method. The POST request includes all of the attributes necessary to run the action. Actions using the POST method are not read-only, and will make changes to the resources you are targeting. |
Authentication
You must attach two custom headers with each request:
- UserGuid: The GUID for the user or system for which you are submitting
- TenantGuid: The GUID for the product for which you are submitting
If the GUIDs do not correspond to the configured rights, the system will return a 403 error response.
Example Request
$ curl https://platform.drndata.com/api/ \ -H "UserGuid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" \ -H "TenantGuid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
Curl uses the -H flag to provide custom headers.
The examples found throughout this document will not include the authentication headers, so you will need to add them yourself.
Parameters
There are two different ways to pass parameters in a request to the API.
When passing parameters to create or update an object, you should pass a JSON object containing the appropriate attribute names and values as key-value pairs. When you use this format, you should specify that you are sending a JSON object in the header by setting the Content-Type header to application/json
.
$ curl -X POST https://platform.drndata.com/api/AddressScoring \ -H "Content-Type: application/json" \ -d '{ ... }'
When passing parameters to filter a response on GET requests, parameters can be passed using standard query attributes. In this case, the parameters would be embedded into the URL itself by appending it to the end of the URL.
$ curl https://platform.drndata.com/api/AddressScoring/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
HTTP Statuses
Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes.
In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered.
In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered.
Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed.
If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having an issue on our end and cannot fulfill your request currently.
Responses
When a request is successful, a response body will typically be sent back in the form of a JSON object.
{ "Vehicle": { "Make": "NISS", "Model": "MURANO", "Plate": { "Issuer": "OH", "Text": "GAA1152", "Year": "" }, "Vin": "11111111111111111", "Year": 2010 } }
Direct Address Scoring

Address Scoring gives the client the ability to verify that a provided address from their customer is valid.
URLs
https://platform.drndata.com/api/AddressScoring
http://staging.external.drndata.com/api/AddressScoring
Protocols
Production HTTPS only
Staging HTTP (HTTPS to come soon)
Headers
Name | Value |
---|---|
Content-Type | application/json |
UserGuid | your_userGuid |
TenantGuid | your_product_tenantGuid |
Methods
- GET
- POST
Creating an Address Score
POST /api/AddressScoring
Fields
Field Name | Types | Required | Notes |
---|---|---|---|
ReferenceID | String | false | May only contain letters, numbers and – or _ |
Location | Object | true | |
City | String | true | |
State | String | true | |
Street1 | String | true | |
Street2 | String | false | |
PostalCode | String | true | Set to string due to possible leading zeros |
Zip4 | String | false | |
Vehicle | Object | true | |
Make | String | false | |
Model | String | false | |
Year | Int | false | |
VIN | String | true | |
Plate | Object | true | |
Issuer | String | false | |
Text | String | false | |
Year | Int | false |
EXAMPLE
Request
{ "ReferenceID": "", "Location": { "City": "Fort Worth", "State": "TX", "Street1": "4150 International Plaza", "Street2": "", "PostalCode": "76109", "Zip4": "" }, "Vehicle": { "Make": "", "Model": "", "Year": "", "VIN": "11111111111111111", "Plate": { "Issuer": "", "Text": "", "Year": "" } } }
Response
"936A3F34-F4E0-415A-9A4C-9330B464CDB8"
Obtaining a previously created Address Score
GET
GET request for address scoring only takes a simple addition of the ReportGuid to the end of the url
Example
Request
https://platform.drndata.com/api/AddressScoring/936A3F34-F4E0-415A-9A4C-9330B464CDB8
http://staging.external.drndata.com/api/AddressScoring/936A3F34-F4E0-415A-9A4C-9330B464CDB8
Response
{ "ExtendedData": [], "ResultDate": "2017-01-13T21:34:08.000", "ResultGuid": "936A3F34-F4E0-415A-9A4C-9330B464CDB8", "ResultType": null, "Result": { "AlternateLocations": 2, "ConfirmDistance": 0, "ConfirmScore": 0, "ConfirmType": 1, "Confirmed": "false", "Coordinate": { "Latitude": 32.6877203, "Longitude": -97.4016601 }, "Location": { "AddressType": 0, "City": "Fort Worth", "LocationReferenceId": null, "PostalCode": 76109, "State": "TX", "Street1": "4150 International Plaze", "Street2": "", "Street3": "", "Zip4": 0 }, "Mileages": [ { "Distance": 1408.5, "Type": 0 }, { "Distance": 1408.5, "Type": 1 }, { "Distance": 1408.5, "Type": 2 }, { "Distance": 1408.5, "Type": 3 } ], "ReferenceId": null, "Seen": 18, "TotalLocations": 2, "ValidLocations": 2, "Version": "Hack/Attack 1.0" }, "Status": 2, "Vehicle": { "Make": "NISS", "Model": "MURANO", "Plate": { "Issuer": "OH", "Text": "GAA1152", "Year": "" }, "Vin": "11111111111111111", "Year": 2010 } }
Product Action Type Reference
Product Action Types
Type | Description |
---|---|
0 | Perform a LocationReport |
1 | Perform an Address Score |
2 | Enable Active Duty Monitoring |
3 | Enable Location Monitoring |
4 | Enable Loss Alerts |
5 | Disable Active Duty Monitoring |
6 | Disable Location Monitoring |
7 | Disable Loss Alerts |
8 | LossAlert |
9 | LocationAlert |
10 | ActiveDutyAlert |
Obtaining DRN Images
Scan Images
To get the images of your scan, you call one of two endpoints to get the car image and the plate image. Both expect the Event ID from any scan
object in your response.
Car Image
URL
https://www.drnweb.net/webrepo/gui/GetCarImage.aspx?TableName=eventsimage&strEventID=<event GUID>

Portfolio Introduction
With the portfolio endpoint, clients can add a list of vehicles that they want to take multiple actions on without having to enter the vehicle every time they wish to run a report. This also gives the client the ability to turn on monitoring products for a vehicle. Think of a portfolio as a filing cabinet and the portfolio entry (vehicle) as the folder. The papers inside the folder are the individual reports for a vehicle.
Portfolio Routes
URLs
Production
https://platform.drndata.com/api/Portfolio
https://platform.drndata.com/api/PortfolioEntry
Staging
http://staging.external.drndata.com/api/Portfolio
http://staging.external.drndata.com/api/PortfolioEntry
Protocols
Production HTTPS only
Staging HTTP (HTTPS to come soon)
Headers
Name | Value |
---|---|
Content-Type | application/json |
UserGuid | your_userGuid |
TenantGuid | your_product_tenantGuid |
Methods
- POST
- GET
Get All Vehicles
GET /api/Portfolio (Get a list of Portfolio Entries)
The following endpoint will return a list of portfolio entries for a client.
URLs
https://platform.drndata.com/api/Portfolio
http://staging.external.drndata.com/api/Portfolio
PARAMETERS
Param Name | Types | Required | Options |
---|---|---|---|
skip | Int | true | |
take | Int | true | |
portfolioGuid | String | true | |
actionType | String | true | All, AddressScoring, LocationReport, LocationAlerts, Loss Alerts |
orderby | String | false | Asc, Desc |
order | String | false | ReferenceId, Vin, Plate, Make, Model, Year |
search | String | false | Search By VIN, Reference ID, or Plate |
count | Int | false | Only use this parameter to get a total count of portfolio entries |
Add a Vehicle
POST /api/PortfolioEntry
Create a single Portfolio Entry.
URLs
https://platform.drndata.com/api/PortfolioEntry
http://staging.external.drndata.com/api/PortfolioEntry
Fields
Field Name | Types | Required | Notes |
---|---|---|---|
ReferenceId | String | false | |
Vehicle | Object | true | |
Year | Int | false | |
Make | String | false | |
Model | String | false | |
VIN | String | true | |
Plate | Object | true | |
Issuer | String | false | |
Text | String | false | |
Year | Int | false | |
Location | Object | true | Only Required if Address Scoring Product is selected. |
City | String | true | |
State | String | true | |
Street1 | String | true | |
Street2 | String | false | |
PostalCode | String | true | Set to string due to possible leading zeros |
Zip4 | String | false | |
AssociatedManualActions | Array | true | 0, 1, 3, 4 Product Action Types |
PortfolioGuid | String | true |
Location object is only needed when Address Scoring is requested in the AssociatedManualActions array.
EXAMPLE
Request
{ "ReferenceId": "AntTest-001", "Vehicle": { "Vin": "11111111111111111", "Make": "VOLVO", "Model": "S60", "Year": "2003", "Plate": { "Text": "kzz930", "Issuer": "TX" } }, "Location": { "City": "Fort Worth", "State": "TX", "PostalCode": "76109", "Street1": "4150 International Plaza" }, "AssociatedManualActions":[1,0,3,4], "PortfolioGuid": "64905FDE-38C0-46A8-BB67-397559B4BF79" }
Response
"C029047F-130F-4C47-B32E-BAC7A38656F6"
Get Single Vehicle
GET /api/PortfolioEntry/:id
The GET PortfolioEntry endpoint will return a individual entry from the clients portfolio.
URLs
https://platform.drndata.com/api/PortfolioEntry/:id
http://staging.external.drndata.com/api/PortfolioEntry/:id
EXAMPLE
Request
URLs
https://platform.drndata.com/api/PortfolioEntry/EA567697-1BEA-4CC1-896B-288BB63C7CE0
Response
{
"Active": true,
"DateCreated": "2016-11-07T15:35:32.000",
"EntryGuid": "EA567697-1BEA-4CC1-896B-288BB63C7CE0",
"PortfolioGuid": "64905FDE-38C0-46A8-BB67-397559B4BF79",
"PrimaryItem": {
"AssociatedActions": [],
"EnabledMonitoredProducts": [1],
"ItemActionHistory": [
{
"ActionDate": "2016-11-07T15:35:32",
"ActionGuid": "BC9D97FD-0904-4B92-8261-4FE439DEBD5F",
"ActionId": 7308842,
"TokenGuid"
: "29C660FE-6F80-47AC-9F01-B3C74C71083D",
"Type": 1,
"UserGuid": "8A5B6183-574C-48C5-92DB-92DC024DB701"
}
],
"PrimaryItemGuid": "DE933BB7-8550-47E8-A5CD-C10A1262D53D",
"Type": null,
"VehicleItemDetails": {
"Make": "",
"Model": "",
"Plate": {
"Issuer": "",
"Text": "dy1h065",
"Year": ""
},
"Vin": "xxxxxxxxxxxxxxxxx",
"Year": ""
}
},
"ReferenceId": "",
"StatusChangeReason": null
}
Editing an Existing Portfolio Entry
PUT /api/PortfolioEntry
{ "Entry": { "PortfolioGuid": "4b242df5-b768-4cf5-aa69-6005e6ee17b0", "PrimaryItem": { "ItemActionHistory": [ { "ActionDate": "2016-10-19T16:13:19.9974576+00:00", "Type": 0, "UserGuid": "ca77539d-66d8-4364-9f10-c98b9082044f", "TokenGuid": "1900db19-2c64-4a4e-98c3-42e5ddcf9748", "ActionGuid": "10eaa4ab-3fee-4457-9229-4d00bc07f618", "ActionId": 5 }, { "ActionDate": "2016-10-19T16:13:19.9974576+00:00", "Type": 0, "UserGuid": "ca77539d-66d8-4364-9f10-c98b9082044f", "TokenGuid": "1900db19-2c64-4a4e-98c3-42e5ddcf9748", "ActionGuid": "10eaa4ab-3fee-4457-9229-4d00bc07f618", "ActionId": 5 } ], "Type": 0, "PrimaryItemGuid": "180c1258-24ee-422e-8de4-4f2a834c2c6d", "VehicleItemDetails": { "Year": "sample string 1", "Make": "sample string 2", "Model": "sample string 3", "Vin": "sample string 4", "Plate": { "Text": "sample string 1", "Issuer": "sample string 2", "Year": "sample string 3" } }, "AssociatedActions": [4], "EnabledMonitoredProducts": [4] }, "EntryGuid": "9f1c9134-f165-49ae-8de6-02dded5675d4", "Active": true, "ReferenceId": "sample string 4", "StatusChangeReason": 0, "DateCreated": "2016-10-19T16:13:20.0130874+00:00" }, "Reason": 0 }
Delete a Vehicle
DELETE /api/PortfolioEntry
This end point will remove the portfolio entry from view of the clients list. This is a soft delete and is done by simply passing the EntryGuid.
URLs
https://platform.drndata.com/api/PortfolioEntry/:id
http://staging.external.drndata.com/api/PortfolioEntry/:id
EXAMPLE
https://platform.drndata.com/api/PortfolioEntry/C029047F-130F-4C47-B32E-BAC7A38656F6
Response
No data is sent back in the response just a status code of 200
Direct Location Reports

Location report gives the client a list of DRN Locations where we have seen their vehicle. A DRN location is determined by clustering all sightings within a 10th of a mile and where there are at least two or more scans. Furthermore, an address is also assigned a score. This score is a four digit number where each digit represents a number of sightings within a certain time period.
Score Example
First Digit | Second Digit | Third Digit | Fourth Digit |
---|---|---|---|
4 | 2 | 6 | 9 |
0 – 30 days | 31 – 90 days | 91 – 180 days | 180+ days |
A score can only have a 9 as its highest number so if a 9 is in the score you know that there was 9 or more scans for that time period.
Creating a new Location Report
POST (Direct Location Report)
URLs
https://platform.drndata.com/api/DirectLocationReport
https://staging.external.drndata.com/api/DirectLocationReport
Fields
Field Name | Types | Required | Notes |
---|---|---|---|
ReferenceId | String | false | |
Vehicle | Object | true | |
Year | Int | false | |
Make | String | false | |
Model | String | false | |
VIN | String | true | |
Plate | Object | true | |
Issuer | String | false | |
Text | String | false | |
Year | Int | false |
EXAMPLE
Request
{ "ReferenceId": "Test Report", "Vehicle": { "Year": "", "Make": "", "Model": "", "Vin": "11111111111111111", "Plate": { "Text": "", "Issuer": "", "Year": "" } } }
Response
84C9FEE3-7923-495F-B139-842BE4F330C2
Obtaining a previously created Location Report
GET (Direct Location Report)
URLs
https://platform.drndata.com/api/LocationReport/84C9FEE3-7923-495F-B139-842BE4F330C2
http://staging.external.drndata.com/api/LocationReport/84C9FEE3-7923-495F-B139-842BE4F330C2
On a GET request the LocationReport controller can be called to get both Direct and Non-Direct reports.
Response
{ "ExtendedData": null, "ResultDate": "2016-12-12T20:05:23.000", "ResultGuid": null, "ResultType": null, "Result": { "ClusteredScores": [ { "Age": 13, "ClusteredLocation": { "Accuracy": 0, "AddressLine1": "20505 South Dixie Highway", "AddressLine2": "", "AddressType": 0, "City": "Cutler Bay", "DeliveryPoint": "", "Lat": 25.57627285, "Lon": -80.36827634, "Phones": [], "PostalCode": 33189, "State": "FL", "Usage": "" }, "Confidence": 2000, "DateFirstSighted": "2016-11-17 10:48:31.000", "DateLastSighted": "2016-11-29 11:27:49.000", "Distance": 1, "Latitude": 25.57627285, "Longitude": -80.36827634, "Missing": 0, "Radius": 150, "Scans": [ { "Latitude": 25.57562963, "Longitude": -80.36851244, "ScanDate": "2016-11-17T10:48:31.000", "ScanID": 5746090919, "EventId": "BBCC23DC-4E10-46C3-B6EB-89FCC39DF26A" }, { "Latitude": 25.57627285, "Longitude": -80.36827634, "ScanDate": "2016-11-29T11:27:49.000", "ScanID": 5796254823, "EventId": "7853729D-44C2-4E44-B87D-691FD29872CC" } ], "ScoreDescription": "Hack/athon 1.0", "SightingCount": 2, "Type": "", "ZCTA": "" } ], "ConfirmScore": 0, "PlateSightings": 2, "ReferenceId": "Test Report", "ScoreDate": "2016-12-12T20:05:23.000" }, "Status": 2, "Vehicle": { "Make": "FORD", "Model": "MUSTANG", "Plate": { "Issuer": "FL", "Text": "GMEV97", "Year": "" }, "Vin": "11111111111111111", "Year": 2008 } }
Loss Alerts

The Loss Alerts product allows you to obtain early notification for various types of events on a vehicle, including Stolen vehicle, Salvaged, Exported and Impounded.
A prerequisite for Loss Alerts is a PortfolioEntry. Please view the documentation on managing your Vehicle Portfolio.
URLs
Production
https://platform.drndata.com/api/LossAlert
https://platform.drndata.com/api/Alerts/:id
https://platform.drndata.com/api/AlertsCount
Staging
http://staging.external.drndata.com/api/LossAlert
http://staging.external.drndata.com/api/Alerts/:id
http://staging.external.drndata.com/api/AlertsCount
Protocols
Production HTTPS only
Staging HTTP (HTTPS to come soon)
Headers
Name | Value |
---|---|
Content-Type | application/json |
UserGuid | your_userGuid |
TenantGuid | your_product_tenantGuid |
Methods
- GET
- POST
Add a Vehicle Subscription for Loss Alerts
Because the Loss Alerts product requires a Portfolio item, you simply add a Portfolio entry with the AssociatedManaualAction array including product action type = 4. This looks like the following:
{ "ReferenceId": "sample string 1", "PortfolioGuid": "fcccf271-dafd-4af1-b809-8da56f5adb2f", "Vehicle": { "Year": "sample string 1", "Make": "sample string 2", "Model": "sample string 3", "Vin": "sample string 4", "Plate": { "Text": "sample string 1", "Issuer": "sample string 2", "Year": "sample string 3" } }, "AssociatedManualActions": [4] }
GET LossAlertSummary
GET api/LossAlertSummary
Query String Parameters
Parameter | Description | Add Info |
start | Date | Required |
end | Date | Optional |
type | String | Required |
skip | Integer | Required |
take | Integer | Required |
orderby | String | Optional (Vin, Plate, Year, Make, Model, ReportDate, LossType) |
order | String | Optional (Asc, Desc) |
complete | String | Optional (1, 0) |
Example Response:
[ { "ReportGuid": "8d898dad-68f0-47cd-aeef-b3bdae65fb28", "ReportDate": "2015-04-23T13:44:26.337935+00:00", "ReportUri": "sample string 3", "Vehicle": { "Year": 1, "Issuer": "sample string 2", "Make": "sample string 3", "Model": "sample string 4", "Vin": "sample string 5", "Plate": { "Text": "sample string 1", "Issuer": "sample string 2", "Year": "sample string 3" } }, "CaseType": 0, "CaseAttributes": { "sample string 1": {}, "sample string 3": {} } }, { "ReportGuid": "8d898dad-68f0-47cd-aeef-b3bdae65fb28", "ReportDate": "2015-04-23T13:44:26.337935+00:00", "ReportUri": "sample string 3", "Vehicle": { "Year": 1, "Issuer": "sample string 2", "Make": "sample string 3", "Model": "sample string 4", "Vin": "sample string 5", "Plate": { "Text": "sample string 1", "Issuer": "sample string 2", "Year": "sample string 3" } }, "CaseType": 0, "CaseAttributes": { "sample string 1": {}, "sample string 3": {} } } ]
GET LossAlert/{guid}
GET api/LossAlert/{guid}
Query String Parameters
Parameter | Description | Add Info |
guid | String | Required |
Example Response:
{ "CaseAttributes": { "CallLogs": [ { "CallLogGuid": "4B6F70D8-EEEE-4063-A974-EC30FE4BD990", "ClientCaseGuid": "6B295803-D514-4E60-A04C-2B12CBD5CDF2", "LogType": 1, "PhoneNumber": null, "LogEntries": [ { "CallDetails": null, "CallLogEntryGuid": "EF72D6C2-1504-422D-9003-B9548C008ACA", "CallLogGuid": "4B6F70D8-EEEE-4063-A974-EC30FE4BD990", "ContactName": null, "DateCreated": "2017-03-10T20:54:42.000", "HoursForReleaseEnd": null, "HoursForReleaseStart": null, "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": null, "LogEntryOutcome": null, "LogType": 1, "PaperworkRequired": null, "StoragePerDay": null } ], "DateCreated": "2017-03-10T20:54:42.000" } ], "CaseDetails": { "ImpoundDate": "2016-03-09", "Source": "NLETS Impound", "Ori": "SC0100800", "Agency": { "Name": "NORTH CHARLESTON PD", "Location": "NORTH CHARLESTON", "Address": "2500 CITY HALL LANE", "City": "2500 CITY HALL LANE", "State": "SC", "Zip": "29419", "MainPhone": "8437437200", "AlternatePhone": "8437402800" }, "PlateNumber": "JPR148", "PlateState": "SC", "PlateYear": null, "PlateType": null, "VehicleYear": 2007, "VehicleMake": "CHRY", "VehicleModel": "300", "VehicleStyle": "SD", "VehicleColor": null, "TowNotes": null, "DamageNotes": null, "PlateNotes": null, "CustodyNotes": null, "SourceNotes": null, "ReferenceNumber1": "21617242", "ReferenceNumber2": null, "ReferenceNumber3": null, "ContactName": "CAROLINA LENDERS", "ContactPhone": null, "ReportingOri": null, "ReportingPhone": null, "ReportingAgency": null, "State": "SC" } }, "CaseType": 0, "ClientReferenceCode": "", "IsActive": false, "IsCompleted": false, "MonitoringStartDate": "", "ReportDate": "2016-07-21", "ReportGuid": "5D022A21-4745-4BE4-B558-8BE081AA9B4A", "ReportUri": "", "Vehicle": { "Make": "CHRYSLER", "Model": "300 SERIES", "Plate": { "Issuer": null, "Text": null, "Year": "" }, "Vin": "2C3KA43R77H665124", "Year": "2007" } }
GET LossAlert [summary] - deprecated
GET api/LossAlertSummary
Query String Parameters
Parameter | Description | Add Info |
start | Date | Required |
end | Date | Optional |
type | String | Required |
skip | Integer | Required |
take | Integer | Required |
orderby | String | Optional (Vin, Plate, Year, Make, Model, ReportDate, LossType) |
order | String | Optional (Asc, Desc) |
complete | String | Optional (1, 0) |
Example Response:
[ { "CaseAttributes": { "LossDate": "2015-01-02T00:00:00.000", "CLossTyp": "", "CauseofLoss": "Other", "Odometer": 129899, "PlateState": "", "LossState": "", "extra": [], "CallLogs": [ { "CallLogGuid": "1BD39FD9-B263-4770-B1FB-4B974675C712", "ClientCaseGuid": "EC353311-2DFA-11E6-80C1-000D3A312380", "LogType": 0, "PhoneNumber": null, "LogEntries": [ { "CallDetails": "test", "CallLogEntryGuid": "36406141-CABC-4C0D-9BAE-030112619FE7", "CallLogGuid": "1BD39FD9-B263-4770-B1FB-4B974675C712", "ContactName": "Anthony Pileggi", "DateCreated": "2016-10-19T22:37:13.000", "HoursForReleaseEnd": null, "HoursForReleaseStart": null, "IsAppointmentRequired": false, "IsDefault": false, "IsImpoundProcessCompleted": false, "LogEntryFlag": null, "LogEntryOutcome": null, "LogType": 0, "PaperworkRequired": [], "StoragePerDay": null }, { "CallDetails": "test", "CallLogEntryGuid": "610023AC-7DA1-4553-AD55-04B7FCDF5056", "CallLogGuid": "1BD39FD9-B263-4770-B1FB-4B974675C712", "ContactName": "Anthony Pileggi", "DateCreated": "2016-10-19T00:02:04.000", "HoursForReleaseEnd": null, "HoursForReleaseStart": null, "IsAppointmentRequired": false, "IsDefault": false, "IsImpoundProcessCompleted": false, "LogEntryFlag": null, "LogEntryOutcome": null, "LogType": 0, "PaperworkRequired": [], "StoragePerDay": null }, { "CallDetails": "", "CallLogEntryGuid": "8D9AB458-F40B-EF7F-F80A-57644EE70505", "CallLogGuid": "1BD39FD9-B263-4770-B1FB-4B974675C712", "ContactName": "", "DateCreated": "2016-09-06T17:42:31.000", "HoursForReleaseEnd": "", "HoursForReleaseStart": "", "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": "", "LogEntryOutcome": "", "LogType": 0, "PaperworkRequired": 0, "StoragePerDay": "" } ], "DateCreated": "2016-06-09T04:30:41.000" }, { "CallLogGuid": "DBBFF1B2-03BA-4ED5-851E-9C4796F63977", "ClientCaseGuid": "EC353311-2DFA-11E6-80C1-000D3A312380", "LogType": 0, "PhoneNumber": null, "LogEntries": [ { "CallDetails": "", "CallLogEntryGuid": "BBFB5D70-AF9D-21BA-6522-ACADB97FCC17", "CallLogGuid": "DBBFF1B2-03BA-4ED5-851E-9C4796F63977", "ContactName": "", "DateCreated": "2016-09-06T17:42:31.000", "HoursForReleaseEnd": "", "HoursForReleaseStart": "", "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": "", "LogEntryOutcome": "", "LogType": 0, "PaperworkRequired": 0, "StoragePerDay": "" } ], "DateCreated": "2016-06-09T04:30:41.000" } ] }, "CaseType": 3, "ClientReferenceCode": "", "IsActive": false, "IsCompleted": true, "MonitoringStartDate": "", "ReportDate": "2015-01-02", "ReportGuid": "BC65F65A-52F1-415E-959F-AD6A0A154CEA", "ReportUri": "", "Vehicle": { "Make": "NISSAN", "Model": "ALTIMA", "Plate": { "Issuer": null, "Text": null, "Year": "" }, "Vin": "11111111111111111", "Year": "2009" } }, { "CaseAttributes": { "StolenRecovered": "Stolen", "PoliceDept": "RUSK COUNTY SHERIFFS DEPARTMENT", "PoliceDeptPhone": "9036573581", "DateOfTheft": "2015-01-04T00:00:00.000", "DateOfEntry": "2015-01-05T00:00:00.000", "DateOfRecovery": "", "PlaceOfRecovery": "", "LicensePlate": "", "LicPlateYear": "", "LicPlateSt": "", "extra": [], "CallLogs": [ { "CallLogGuid": "B55AC9FA-A669-48F0-AF69-60F09531A2DF", "ClientCaseGuid": "EC1FAFBF-E4EC-11E5-80C5-000D3A312380", "LogType": 0, "PhoneNumber": null, "LogEntries": [ { "CallDetails": "NOOOOOTE", "CallLogEntryGuid": "57706F65-3B08-49B0-AA42-8AEFD460D29C", "CallLogGuid": "B55AC9FA-A669-48F0-AF69-60F09531A2DF", "ContactName": "Adam Brown", "DateCreated": "2016-11-03T15:15:12.000", "HoursForReleaseEnd": null, "HoursForReleaseStart": null, "IsAppointmentRequired": false, "IsDefault": false, "IsImpoundProcessCompleted": false, "LogEntryFlag": null, "LogEntryOutcome": null, "LogType": 0, "PaperworkRequired": [], "StoragePerDay": null }, { "CallDetails": "", "CallLogEntryGuid": "1D52E3A7-0C70-FC22-89CD-8E40BC694B3B", "CallLogGuid": "B55AC9FA-A669-48F0-AF69-60F09531A2DF", "ContactName": "", "DateCreated": "2016-09-06T17:42:31.000", "HoursForReleaseEnd": "", "HoursForReleaseStart": "", "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": "", "LogEntryOutcome": "", "LogType": 0, "PaperworkRequired": 0, "StoragePerDay": "" } ], "DateCreated": "2016-03-08T05:16:36.000" }, { "CallLogGuid": "67FD8D50-10F1-46D5-98DA-EB7BEBA39694", "ClientCaseGuid": "EC1FAFBF-E4EC-11E5-80C5-000D3A312380", "LogType": 0, "PhoneNumber": null, "LogEntries": [ { "CallDetails": "", "CallLogEntryGuid": "9FEA7412-426A-3559-6190-E148D317A138", "CallLogGuid": "67FD8D50-10F1-46D5-98DA-EB7BEBA39694", "ContactName": "", "DateCreated": "2016-09-06T17:42:31.000", "HoursForReleaseEnd": "", "HoursForReleaseStart": "", "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": "", "LogEntryOutcome": "", "LogType": 0, "PaperworkRequired": 0, "StoragePerDay": "" } ], "DateCreated": "2016-03-08T05:16:36.000" } ] }, "CaseType": 2, "ClientReferenceCode": "", "IsActive": false, "IsCompleted": false, "MonitoringStartDate": "", "ReportDate": "2015-01-05", "ReportGuid": "C3126137-5DB8-498C-B28D-8D3F171C896C", "ReportUri": "", "Vehicle": { "Make": "FARM EQUIPMENT", "Model": "FARM EQUIPMENT", "Plate": { "Issuer": null, "Text": null, "Year": "" }, "Vin": "11111111111111111", "Year": "2012" } }, { "CaseAttributes": { "StolenRecovered": "Recovered", "PoliceDept": "", "PoliceDeptPhone": "", "DateOfTheft": "2015-01-02T00:00:00.000", "DateOfEntry": "2015-01-06T00:00:00.000", "DateOfRecovery": "2016-03-21T00:00:00.000", "PlaceOfRecovery": "POLICE DEPARTMENT", "LicensePlate": "6HCSD", "LicPlateYear": "2015", "LicPlateSt": "TX", "extra": [], "CallLogs": [ { "CallLogGuid": "D8827C41-7440-4A0E-84F1-AC89D6FDCA6B", "ClientCaseGuid": "D4D1D92B-EFE6-11E5-80C6-000D3A312380", "LogType": 0, "PhoneNumber": null, "LogEntries": [ { "CallDetails": "", "CallLogEntryGuid": "4DCA7EA4-F69B-869C-9B9D-B98164B1721D", "CallLogGuid": "D8827C41-7440-4A0E-84F1-AC89D6FDCA6B", "ContactName": "", "DateCreated": "2016-09-06T17:42:31.000", "HoursForReleaseEnd": "", "HoursForReleaseStart": "", "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": "", "LogEntryOutcome": "", "LogType": 0, "PaperworkRequired": 0, "StoragePerDay": "" } ], "DateCreated": "2016-03-22T04:30:49.000" }, { "CallLogGuid": "FFE36D02-7948-424E-8EDC-C13D16B55862", "ClientCaseGuid": "D4D1D92B-EFE6-11E5-80C6-000D3A312380", "LogType": 0, "PhoneNumber": null, "LogEntries": [ { "CallDetails": "", "CallLogEntryGuid": "997849BA-5E73-7C98-D791-DC9167F016CD", "CallLogGuid": "FFE36D02-7948-424E-8EDC-C13D16B55862", "ContactName": "", "DateCreated": "2016-09-06T17:42:31.000", "HoursForReleaseEnd": "", "HoursForReleaseStart": "", "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": "", "LogEntryOutcome": "", "LogType": 0, "PaperworkRequired": 0, "StoragePerDay": "" } ], "DateCreated": "2016-03-22T04:30:49.000" } ] }, "CaseType": 2, "ClientReferenceCode": "", "IsActive": false, "IsCompleted": false, "MonitoringStartDate": "", "ReportDate": "2015-01-06", "ReportGuid": "F998FC65-CF6D-478A-9CEC-EC952BDE4116", "ReportUri": "", "Vehicle": { "Make": "NISSAN", "Model": "ALTIMA", "Plate": { "Issuer": null, "Text": null, "Year": "" }, "Vin": "11111111111111111", "Year": "2009" } }, { "CaseAttributes": { "StolenRecovered": "Recovered", "PoliceDept": "GALVESTON POLICE DEPARTMENT", "PoliceDeptPhone": "4097653702", "DateOfTheft": "2014-12-29T00:00:00.000", "DateOfEntry": "2015-01-07T00:00:00.000", "DateOfRecovery": "2015-10-05T00:00:00.000", "PlaceOfRecovery": "", "LicensePlate": "CZH2932", "LicPlateYear": "2015", "LicPlateSt": "TX", "extra": [], "CallLogs": [ { "CallLogGuid": "D330B46F-A993-11E5-8287-0023AE8707D5", "ClientCaseGuid": "6266D108-6F14-11E5-80C4-000D3A307CA3", "LogType": 0, "PhoneNumber": null, "LogEntries": [ { "CallDetails": "NoteJS", "CallLogEntryGuid": "64E77B84-FA0D-4C4C-9E73-09F23C5AC3F1", "CallLogGuid": "D330B46F-A993-11E5-8287-0023AE8707D5", "ContactName": "Adam Brown", "DateCreated": "2016-11-01T15:18:26.000", "HoursForReleaseEnd": null, "HoursForReleaseStart": null, "IsAppointmentRequired": false, "IsDefault": false, "IsImpoundProcessCompleted": false, "LogEntryFlag": null, "LogEntryOutcome": null, "LogType": 0, "PaperworkRequired": [], "StoragePerDay": null }, { "CallDetails": "", "CallLogEntryGuid": "DDCC3E25-3C8F-B2BA-9ADE-5BDD427C1449", "CallLogGuid": "D330B46F-A993-11E5-8287-0023AE8707D5", "ContactName": "", "DateCreated": "2016-09-06T17:42:31.000", "HoursForReleaseEnd": "", "HoursForReleaseStart": "", "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": "", "LogEntryOutcome": "", "LogType": 0, "PaperworkRequired": 0, "StoragePerDay": "" } ], "DateCreated": "2015-10-10T06:01:53.000" } ] }, "CaseType": 2, "ClientReferenceCode": "", "IsActive": false, "IsCompleted": false, "MonitoringStartDate": "", "ReportDate": "2015-01-07", "ReportGuid": "A18A63A7-7D4B-41B9-89A1-3EA846A43D87", "ReportUri": "", "Vehicle": { "Make": "FORD", "Model": "F250 SERIES", "Plate": { "Issuer": null, "Text": null, "Year": "" }, "Vin": "11111111111111111", "Year": "2006" } }, { "CaseAttributes": { "StolenRecovered": "Stolen", "PoliceDept": "", "PoliceDeptPhone": "", "DateOfTheft": "2015-01-07T00:00:00.000", "DateOfEntry": "2015-01-07T00:00:00.000", "DateOfRecovery": "", "PlaceOfRecovery": "", "LicensePlate": "48MLH7", "LicPlateYear": "2015", "LicPlateSt": "TX", "extra": [], "CallLogs": [ { "CallLogGuid": "969BB0DB-D107-49F0-93C8-195880243651", "ClientCaseGuid": "DED44EA9-0CF7-11E6-80C1-000D3A312380", "LogType": 0, "PhoneNumber": null, "LogEntries": [ { "CallDetails": "", "CallLogEntryGuid": "839466B2-205B-DBD4-E794-48F64BC8CEB4", "CallLogGuid": "969BB0DB-D107-49F0-93C8-195880243651", "ContactName": "", "DateCreated": "2016-09-06T17:42:31.000", "HoursForReleaseEnd": "", "HoursForReleaseStart": "", "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": "", "LogEntryOutcome": "", "LogType": 0, "PaperworkRequired": 0, "StoragePerDay": "" } ], "DateCreated": "2016-04-28T04:15:46.000" }, { "CallLogGuid": "EB7F4B62-AD55-4F61-A686-7E0A1FE5A732", "ClientCaseGuid": "DED44EA9-0CF7-11E6-80C1-000D3A312380", "LogType": 0, "PhoneNumber": null, "LogEntries": [ { "CallDetails": "", "CallLogEntryGuid": "F68F4326-9A26-ADC5-1D5F-3BAA9DED6024", "CallLogGuid": "EB7F4B62-AD55-4F61-A686-7E0A1FE5A732", "ContactName": "", "DateCreated": "2016-09-06T17:42:31.000", "HoursForReleaseEnd": "", "HoursForReleaseStart": "", "IsAppointmentRequired": false, "IsDefault": true, "IsImpoundProcessCompleted": false, "LogEntryFlag": "", "LogEntryOutcome": "", "LogType": 0, "PaperworkRequired": 0, "StoragePerDay": "" } ], "DateCreated": "2016-04-28T04:15:46.000" } ] }, "CaseType": 2, "ClientReferenceCode": "", "IsActive": false, "IsCompleted": false, "MonitoringStartDate": "", "ReportDate": "2015-01-07", "ReportGuid": "7E1C158A-5664-40F8-B258-3B362760DD7D", "ReportUri": "", "Vehicle": { "Make": "FORD", "Model": "ECONOLINE E150", "Plate": { "Issuer": null, "Text": null, "Year": "" }, "Vin": "11111111111111111", "Year": "2001" } } ]
Location Alerts
URLs
Production
https://platform.drndata.com/api/LocationMonitoredEntries
https://platform.drndata.com/api/LocationMonitoredEntry
https://platform.drndata.com/api/LocationAlert
https://platform.drndata.com/api/PortfolioEntry/:id
Staging
http://staging.external.drndata.com/api/LocationMonitoredEntries
http://staging.external.drndata.com/api/LocationMonitoredEntry
http://staging.external.drndata.com/api/LocationAlert
http://staging.external.drndata.com/api/PortfolioEntry/:id
Protocols
Production HTTPS only
Staging HTTP (HTTPS to come soon)
Headers
Name | Value |
---|---|
Content-Type | application/json |
UserGuid | your_userGuid |
TenantGuid | your_product_tenantGuid |
Methods
- GET
- POST
- PUT
GET LocationMonitoredEntries
This endpoint will return a list of all alerts for vehicles that were being monitored in a portfolio.
Query Fields
Param Name | Types | Required | Notes |
---|---|---|---|
skip | Int | true | |
take | Int | true | |
orderby | String | false | Asc, Desc |
order | String | false | ReferenceId, Vin, Plate, Make, Model, Year |
search | String | false | Search By VIN, Reference ID, or Plate |
portfolioGuid | String | true | |
start | String | true | |
end | String | false | |
count | Int | false | Only use this parameter to get a total count of alerts and set value to 1 |
Example
Request
https://platform.drndata.com/api/LocationMonitoredEntries?portfolioGuid=your_portfolio_guid&skip=0&take=10&start=01/1/2017&end=01/10/2017&count=1&orderby=ReferenceID&order=Asc&search
Response
[
{
"EntryGuid": "189D29BE-DB4A-4D8D-853D-506E638C06CB",
"ExpirationDate": "",
"LocationMonitorHits": [
{
"IsVerified": true,
"Latitude": 36.82628077,
"LocationAlertGuid": "62C3D528-AA07-4BA4-9C7E-0554C8F2E7BD",
"Longitude": -76.3388064,
"PlateText": "VNC3023",
"ScanDate": "2016-08-05T13:45:52.000",
"ScanID": 3133589834,
"ScanImageGuid": "DD5D49E2-2602-471D-9C1C-BDA08A989937"
},
{
"IsVerified": true,
"Latitude": 37.56167818,
"LocationAlertGuid": "6D66B43D-1C86-4BA2-AC7F-2FAC665C35A2",
"Longitude": -77.41059752,
"PlateText": "VNC3023",
"ScanDate": "2016-12-09T15:35:26.000",
"ScanID": 3136259724,
"ScanImageGuid": "25B0E41C-AADC-4F17-B297-97EA7CA671EB"
}
],
"MonitoringEnabled": true,
"NumberOfHits": 2,
"PrimaryItemGuid": "7341960E-78CB-4E14-9732-BC433E63EE80",
"ReferenceId": null,
"ScanDate": "2016-12-09T15:35:26.000",
"TokenGuid": "B57C3AAE-12BA-442B-B285-50A416226006",
"VehicleItemDetails": {
"Make": "Scion",
"Model": "tC",
"Plate": {
"Issuer": "VA",
"Text": "VNC3023",
"Year": ""
},
"Vin": "1111111111111111",
"Year": 2009
}
},
{
"EntryGuid": "E84D69C6-75C8-4AA1-9D9E-D200D03E2036",
"ExpirationDate": "",
"LocationMonitorHits": [
{
"IsVerified": true,
"Latitude": 32.86167997,
"LocationAlertGuid": "F2865053-C70F-490B-BDFA-15D13CDEC740",
"Longitude": -96.89983779,
"PlateText": "HBZ5529",
"ScanDate": "2017-01-03T16:44:51.000",
"ScanID": 3133096928,
"ScanImageGuid": "63564DFD-5174-44D2-A88D-A11F694370D4"
},
{
"IsVerified": true,
"Latitude": 32.86169339,
"LocationAlertGuid": "889150EC-86F1-4591-BFB7-3385218D1007",
"Longitude": -96.89982226,
"PlateText": "HBZ5529",
"ScanDate": "2017-01-03T21:02:16.000",
"ScanID": 3133096928,
"ScanImageGuid": "9F207114-5D33-4DC6-84D7-D2283F710F0A"
}
],
"MonitoringEnabled": true,
"NumberOfHits": 2,
"PrimaryItemGuid": "78DB6424-DCA8-40C4-99B5-632AF07025A2",
"ReferenceId": null,
"ScanDate": "2017-01-10T08:37:13.000",
"TokenGuid": "C17ABC95-2291-482B-A95D-9E68656C6B00",
"VehicleItemDetails": {
"Make": "DODGE",
"Model": "DURANGO",
"Plate": {
"Issuer": "",
"Text": "HBZ5529",
"Year": ""
},
"Vin": "11111111111111111",
"Year": 2006
}
}
]
PUT Update Monitoring Status on a Vehicle
To change the current monitoring status of a vehicle you must do a PUT call to PortfolioEntry
. To do the update you must send an object with two properties. Entry & Reason. Entry will have a copy of the portfolio entry object and in this object we will update the AssociatedActions array with 3 or 6. The Reason property will have a single Int value which represents the status of the entry. Please review the list below for reason codes.
URLs
- Production:
https://platform.drndata.com/api/PortfolioEntry/:id
- Staging:
http://staging.external.drndata.com/api/PortfolioEntry/:id
Headers
Name | Value |
---|---|
Content-Type | application/json |
UserGuid | your_userGuid |
TenantGuid | your_product_tenantGuid |
Associated Actions values
Name | Value |
---|---|
Enable | 3 |
Disabled | 6 |
Reason Codes
Name | Value |
---|---|
0 | Repossessed |
1 | Vehicle Located But Cannot Be Recovered |
2 | Closed Due to Time |
3 | Closed for Customer Payment |
4 | Closed for Further Investigation |
5 | Other |
6 | Activated |
Example
Request
{
"Entry": {
"Active": true,
"DateCreated": "2016-09-06T17:47:03.000",
"EntryGuid": "DCB910F9-48B8-4DE0-B2EE-7EC173B7729E",
"PortfolioGuid": "B8E92758-4E2B-4094-9A54-F975DB082098",
"PrimaryItem": {
"AssociatedActions": [
3
],
"EnabledMonitoredProducts": [
6
],
"ItemActionHistory": [
{
"ActionDate": "2015-10-19T14:31:53",
"ActionGuid": "40FC4461-3F5B-4453-9676-3B80E753F512",
"ActionId": 6871955,
"TokenGuid": "2E6A6CD3-12A8-4A25-A662-11A960A72A77",
"Type": 9,
"UserGuid": "00000000-0000-0000-0000-000000000000"
}
],
"PrimaryItemGuid": "7CD7A4AD-5691-251F-2C19-DDA153C12FB6",
"Type": null,
"VehicleItemDetails": {
"Make": "CHEVROLET",
"Model": "MALIBU",
"Plate": {
"Issuer": "OH",
"Text": "FCS7795",
"Year": ""
},
"Vin": "11111111111111111",
"Year": ""
}
},
"ReferenceId": "0023",
"StatusChangeReason": "6"
},
"Reason": 6
}
GET LocationMonitoredEntry
This endpoint will return a single Location Alert Entry and its associated scans.
URLs
Production
https://platform.drndata.com/api/LocationMonitoredEntry?entryGuid=ENTRY_GUID&tokenGuid="TOKEN_GUID
Staging
http://staging.external.drndata.com/api/LocationMonitoredEntry?entryGuid=ENTRY_GUID&tokenGuid="TOKEN_GUID
Headers
Name | Value |
---|---|
Content-Type | application/json |
UserGuid | your_userGuid |
TenantGuid | your_product_tenantGuid |
Example
Request
http://staging.external.drndata.com/api/locationMonitoredEntry?entryGuid=DCB910F9-48B8-4DE0-B2EE-7EC173B7729E&tokenGuid=13643D66-2AE0-40E6-8955-AC4935F2F98D&portfolioGuid=B8E92758-4E2B-4094-9A54-F975DB082098
Response
{
"EntryGuid": "DCB910F9-48B8-4DE0-B2EE-7EC173B7729E",
"ExpirationDate": "",
"LocationMonitorHits": [
{
"IsVerified": false,
"Latitude": 41.698850199,
"LocationAlertGuid": "40FC4461-3F5B-4453-9676-3B80E753F512",
"Longitude": -83.5436130289,
"PlateText": "FCS7795",
"ScanDate": "2015-10-19T14:31:53.000",
"ScanID": 3128739711,
"ScanImageGuid": "6C2D8A90-0294-447C-96C0-89B5146EFC6B"
},
{
"IsVerified": false,
"Latitude": 41.698850199,
"LocationAlertGuid": "62F65276-6C35-4E7F-BD49-5D5B0FD2EF4E",
"Longitude": -83.5436130289,
"PlateText": "FCS7795",
"ScanDate": "2015-10-19T14:31:53.000",
"ScanID": 3128739711,
"ScanImageGuid": "6C2D8A90-0294-447C-96C0-89B5146EFC6B"
}
],
"MonitoringEnabled": true,
"NumberOfHits": 2,
"PrimaryItemGuid": "7CD7A4AD-5691-251F-2C19-DDA153C12FB6",
"ReferenceId": "0023",
"ScanDate": "2016-08-09T17:55:44.000",
"TokenGuid": "13643D66-2AE0-40E6-8955-AC4935F2F98D",
"VehicleItemDetails": {
"Make": "CHEVROLET",
"Model": "MALIBU",
"Plate": {
"Issuer": "OH",
"Text": "FCS7795",
"Year": ""
},
"Vin": "11111111111111111",
"Year": ""
}
}
POST LocationAlert
This endpoint is used for validating the individual scans associated with each Location Alert.
URLs
Production
https://platform.drndata.com/api/LocationAlert
Staging
http://staging.external.drndata.com/api/LocationAlert
Headers
Name | Value |
---|---|
Content-Type | application/json |
UserGuid | your_userGuid |
TenantGuid | your_product_tenantGuid |
Example
Request
{
"IsVerified": true,
"Latitude": "41.698850198999999",
"LocationAlertGuid": "40FC4461-3F5B-4453-9676-3B80E753F512",
"Longitude": "-83.543613028899998",
"PlateText": "FCS7795",
"ScanDate": "2015-10-19T14:31:53.000",
"ScanID": "3128739711",
"ScanImageGuid": "6C2D8A90-0294-447C-96C0-89B5146EFC6B",
"markerCenter": {
"latitude": "41.698850198999999",
"longitude": "-83.543613028899998"
},
"portfolioGuid": "B8E92758-4E2B-4094-9A54-F975DB082098"
}
Response
"40FC4461-3F5B-4453-9676-3B80E753F512"
Active Duty
Methods
- GET /Person/:id & /Person
- POST /Person
- PUT /Person & /Person/Action/:id
- DELETE /Person/:id
Get Single Person
GET /api/Person/:id & /Person
Gets a single person object or an array of person objects.
URLs
https://platform.drndata.com/api/Person/id=PersonGuid
http://staging.external.drndata.com/api/Person/id=PersonGuid
EXAMPLE
Response
{ "PersonGuid": "person_guid", "ReferenceId": 3994325872, "GroupId": null, "LastCheckDate": "2016-10-31", "LastStatusDate": "2016-10-31", "ActiveDutyStartDate": "2016-10-31", "ActiveDutyEndDate": "2016-10-31", "Branch": "Army", "Status": "Pending", "Codes": { "LeftActiveDuty": "N", "NotifiedOfRecall": "N", "ActiveDuty": "X", "ServiceComponent": "AG", "Match": 1, "Error": 9 }, "AssociatedActions": [2] }
Get All People
GET /api/Person?skip=0&take=15
Gets multiple people back from the person controller and takes query parameters consisting of a reference id and how values to be returned. The count can be added as well as an optional parameter.
URLs
Production
https://platform.drndata.com/api/Person?skip=0&take=15
https://platform.drndata.com/api/Person?skip=0&take=15&count=1
Staging
http://staging.external.drndata.com/api/Person?skip=0&take=15
http://staging.external.drndata.com/api/Person?skip=0&take=15&count=1
Query String Parameters
Parameter | Description | Add Info |
reference id | Integer | Required |
skip | Integer | Required |
take | Integer | Required |
count | Integer | Optional |
Example Response:
EXAMPLE
Response
{ "PersonGuid": "person_guid", "ReferenceId": 3994325872, "GroupId": null, "LastCheckDate": "2016-10-31", "LastStatusDate": "2016-10-31", "ActiveDutyStartDate": "2016-10-31", "ActiveDutyEndDate": "2016-10-31", "Branch": "Army", "Status": "Pending", "Codes": { "LeftActiveDuty": "N", "NotifiedOfRecall": "N", "ActiveDuty": "X", "ServiceComponent": "AG", "Match": 1, "Error": 9 }, "AssociatedActions": [2] }
Create Person
POST /api/Person
POST takes in a JSON object with certain fields that are required. After the person object is created you will not get back first, middle, or last name. After creation DOB and SSN are also not visible again in order to protect P2 data.
URLs
https://platform.drndata.com/api/Person
http://staging.external.drndata.com/api/Person
PARAMETERS
Param Name | Types | Required | Options |
---|---|---|---|
FirstName | String | true | |
LastName | String | true | |
DOB | DateTime | true | If SSN not provided |
SSN | String | true | If DOB not provided; input text is hidden |
EXAMPLE
Example POST object
{
"ReferenceId": 3994325872,
"GroupId": null,
"FirstName": "John",
"MiddleName": null,
"LastName": "Doe",
"DateOfBirth": null,
"Ssn": null
}
Response
{ "PersonGuid": "E03EE92B-0089-4F53-BF32-78A68101D589", "ReferenceId": 3994325872, "GroupId": null, "LastCheckDate": null }
Update Person
PUT /api/Person
The first put is to update the person object its self. You can update can only update ReferenceId and GroupId however at this time.
URLs
https://platform.drndata.com/api/Person
http://staging.external.drndata.com/api/Person
EXAMPLE
Example PUT object
{ "PersonGuid": "E03EE92B-0089-4F53-BF32-78A68101D589", "ReferenceId": 3994325872, "GroupId": null, "LastCheckDate": null }
Update Person Action
PUT /api/Person/Action
This PUT method is for subscribing and unsubscribing person objects. By default a person is subscribed on creation.
URLs
https://platform.drndata.com/api/Person/Action
http://staging.external.drndata.com/api/Person/Action
EXAMPLE
Example PUT object
{ "AssociatedActions": [2] }
Delete Person
DELETE /api/Person/
This end point only take a PersonGuid and will unsubscribe the person and then remove the person for client list.
URLs
https://platform.drndata.com/api/Person/EntryGuid
http://staging.external.drndata.com/api/Person/EntryGuid