NPS-LIC: Difference between revisions
(→VIN) |
(→Output) |
||
| Line 23: | Line 23: | ||
== Output == | == Output == | ||
We provide a JSON formatted output of the results available from this API endpoint. | We provide a JSON formatted output of the results available from this API endpoint.<br> | ||
The barcode is encoded with data from the eNatis system linked to the vehicle.<br> | |||
[[File:NPS-LIC JSON.png|400px|thumb|right|NPS-LIC JSON output]] | [[File:NPS-LIC JSON.png|400px|thumb|right|NPS-LIC JSON output]] | ||
=== VIN === | === VIN === | ||
The decoded barcode (Vehicle Identification Number) VIN number for the vehicle. | The decoded barcode (Vehicle Identification Number) VIN number for the vehicle. | ||
=== scan_plate === | === scan_plate === | ||
The decoded barcode Vehicle number plate (Licence plate) for the vehicle. | |||
=== scan_manuf === | === scan_manuf === | ||
The decoded barcode Vehicle manufacturer for the vehicle. | |||
=== scan_model === | === scan_model === | ||
The decoded barcode Vehicle manufacturer for the vehicle. | |||
=== scan_class === | === scan_class === | ||
The decoded barcode Vehicle class for the vehicle. | |||
=== scan_eng === | === scan_eng === | ||
The decoded barcode Vehicle engine number for the vehicle. | |||
=== scan_date === | === scan_date === | ||
The decoded barcode Vehicle licence disk expiry date for the vehicle. | |||
=== scan_type === | === scan_type === | ||
=== pic_url === | === pic_url === | ||
The VIN number is used to provide a image of the same vehicle make and model for visual confirmation by an operator. | |||
=== manufacturer === | === manufacturer === | ||
The manufacturer linked in the propriaty NPS-VCR system. | |||
=== plant === | === plant === | ||
The manufacturer plant used to produce the vehicle linked in the propriaty NPS-VCR system. | |||
=== brand === | === brand === | ||
The manufacturer linked in the propriaty NPS-VCR system. | |||
=== model === | === model === | ||
The vehicles model linked in the propriaty NPS-VCR system. | |||
=== year === | === year === | ||
The vehicles manufacturers release/produced year linked to the VIN number of the vehicle. | |||
=== engin_number === | === engin_number === | ||
The vehicles engine number linked in the propriaty NPS-VCR system. | |||
=== TokensLeft === | === TokensLeft === | ||
The number of token credits left for your [[NPS-CLOUD]] account. | |||
=== unlock === | === unlock === | ||
Returns a true and report if the user is allowed to inquire the drivers license details.<br> | Returns a true and report if the user is allowed to inquire the drivers license details.<br> | ||
Return false if, for instance, the users token credits have run out. | Return false if, for instance, the users token credits have run out. | ||
=== checks === | === checks === | ||
==== np_tracker ==== | ==== np_tracker ==== | ||
If <u>true</u> then there is a vehicle lookout report from the NP Tracker suspect and suspicious vehicle database linked to the vehicle, alternativly it will return <u>false</u> | |||
==== external ==== | ==== external ==== | ||
==== expired ==== | ==== expired ==== | ||
Revision as of 07:58, 12 April 2019
 This is the developer's corner to aid in integrating our RESTfull API into their apps. |
Interface
This is a REST API endpoint using HTTP GET.
Available to any device/server on the internet.
Usage
To use this endpoint you will need a valid API Key available after registration on NPS-CLOUD.
See our API documentation page for advance help and examples on using this endpoint.
Parameters
scan
The URI encoded text string of the Licence disk PDF-417 barcode.
vin
The 17 character VIN number to be tested.
token
This is your NPS-CLOUD account access token (API Key) available under the NPS-API menu in your NPS-CLOUD account.
Output
We provide a JSON formatted output of the results available from this API endpoint.
The barcode is encoded with data from the eNatis system linked to the vehicle.
VIN
The decoded barcode (Vehicle Identification Number) VIN number for the vehicle.
scan_plate
The decoded barcode Vehicle number plate (Licence plate) for the vehicle.
scan_manuf
The decoded barcode Vehicle manufacturer for the vehicle.
scan_model
The decoded barcode Vehicle manufacturer for the vehicle.
scan_class
The decoded barcode Vehicle class for the vehicle.
scan_eng
The decoded barcode Vehicle engine number for the vehicle.
scan_date
The decoded barcode Vehicle licence disk expiry date for the vehicle.
scan_type
pic_url
The VIN number is used to provide a image of the same vehicle make and model for visual confirmation by an operator.
manufacturer
The manufacturer linked in the propriaty NPS-VCR system.
plant
The manufacturer plant used to produce the vehicle linked in the propriaty NPS-VCR system.
brand
The manufacturer linked in the propriaty NPS-VCR system.
model
The vehicles model linked in the propriaty NPS-VCR system.
year
The vehicles manufacturers release/produced year linked to the VIN number of the vehicle.
engin_number
The vehicles engine number linked in the propriaty NPS-VCR system.
TokensLeft
The number of token credits left for your NPS-CLOUD account.
unlock
Returns a true and report if the user is allowed to inquire the drivers license details.
Return false if, for instance, the users token credits have run out.
checks
np_tracker
If true then there is a vehicle lookout report from the NP Tracker suspect and suspicious vehicle database linked to the vehicle, alternativly it will return false