NPS-LIC - Revision history

NPTracker at 07:42, 31 May 2023

2023-05-31T07:42:32Z

← Older revision		Revision as of 07:42, 31 May 2023
Line 5:		Line 5:
	\|description=API interface to decode and test South African Motor Vehicle Licence Disk barcodes		\|description=API interface to decode and test South African Motor Vehicle Licence Disk barcodes
	}}		}}
	{{API\|1=This is the developer's corner to aid in integrating our ~~RESTfull~~ API into their apps.}}		{{API\|1=This is the developer's corner to aid in integrating our RESTful API into their apps.}}
	== Interface ==		== Interface ==
	This is a [[REST API]] endpoint using HTTP GET.<br>		This is a [[REST API]] endpoint using HTTP GET.<br>
Line 11:		Line 11:
	== Usage ==		== Usage ==
	To use this endpoint you will need a valid [[API Key]] available after registration on [[NPS-CLOUD]].<br>		To use this endpoint you will need a valid [[API Key]] available after registration on [[NPS-CLOUD]].<br>
	See our [https://api.nptracker.co.za/docs API documentation page] for ~~advance~~ help and examples on using this endpoint.		See our [https://api.nptracker.co.za/docs/ API documentation page] for advanced help and examples on using this endpoint.
	=== Parameters ===		=== Parameters ===
	==== scan ====		==== scan ====
Line 46:		Line 46:

	=== 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.		The VIN number is used to provide an 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.		The manufacturer is linked to the propriety NPS-VCR system.
	=== plant ===		=== plant ===
	The manufacturer plant used to produce the vehicle linked in the ~~propriaty~~ NPS-VCR system.		The manufacturer plant used to produce the vehicle linked in the propriety NPS-VCR system.
	=== brand ===		=== brand ===
	The manufacturer linked in the ~~propriaty~~ NPS-VCR system.		The manufacturer is linked to the propriety NPS-VCR system.
	=== model ===		=== model ===
	The ~~vehicles~~ model linked in the ~~propriaty~~ NPS-VCR system.		The vehicle model is linked to the propriety NPS-VCR system.
	=== year ===		=== year ===
	The ~~vehicles manufacturers~~ release/~~produced~~ year linked to the VIN number of the vehicle.		The vehicle manufacturer's release/production year is linked to the VIN number of the vehicle.
	=== engin_number ===		=== engin_number ===
	The ~~vehicles~~ engine number linked in the ~~propriaty~~ NPS-VCR system.		The vehicle's engine number is linked to the propriety NPS-VCR system.
	=== TokensLeft ===		=== TokensLeft ===
	The number of token credits left for your [[NPS-CLOUD]] account.		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 report if the user is allowed to inquire about the license details.<br>
	Return false if, for instance, the ~~users~~ token credits have run out.		Return false if, for instance, the user's 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>.		If <u>true</u> then there is a vehicle lookout report from the NP Tracker suspect and suspicious vehicle database linked to the vehicle, alternatively it will return <u>false</u>.
	==== external ====		==== external ====
	==== expired ====		==== expired ====
	If <u>true</u> then the date on the licence disk ~~have~~ expired, else <u>false</u> ie. disk is still valid.		If <u>true</u> then the date on the licence disk has expired, else <u>false</u> ie. disk is still valid.
	==== manufacturer ====		==== manufacturer ====
	If <u>true</u> then the scanned manufacturer and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>.		If <u>true</u> then the scanned manufacturer and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>.

NPTracker: /* scan_type */

2019-04-12T08:09:04Z

scan_type

← Older revision		Revision as of 08:09, 12 April 2019
Line 41:		Line 41:
	The decoded barcode Vehicle licence disk expiry date for the vehicle.		The decoded barcode Vehicle licence disk expiry date for the vehicle.
	=== scan_type ===		=== scan_type ===
			We currently scan and decode the following barcode encoding formats:
			* <strong>MVL</strong> - Motor Vehicle Licence
			* <strong>RC</strong> - Registration Certificate.

	=== 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.		The VIN number is used to provide a image of the same vehicle make and model for visual confirmation by an operator.

NPTracker: /* checks */

2019-04-12T08:04:42Z

checks

← Older revision		Revision as of 08:04, 12 April 2019
Line 63:		Line 63:
	==== 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>.		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 ====
	If <u>true</u> then the date on the licence disk have expired, else <u>false</u> ie. disk is still valid.		If <u>true</u> then the date on the licence disk have expired, else <u>false</u> ie. disk is still valid.

	==== manufacturer ====		==== manufacturer ====
	If <u>true</u> then the scanned manufacturer and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>.		If <u>true</u> then the scanned manufacturer and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>.

	==== model ====		==== model ====
			If <u>true</u> then the scanned vehicle model and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>.
	==== engine ====		==== engine ====
			If <u>true</u> then the scanned vehicle engine number and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>.
	==== colour ====		==== colour ====
			If <u>true</u> then the scanned vehicle colour and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>.

NPTracker: /* manufacturer */

2019-04-12T08:03:41Z

manufacturer

← Older revision		Revision as of 08:03, 12 April 2019
Line 69:		Line 69:

	==== manufacturer ====		==== manufacturer ====
			If <u>true</u> then the scanned manufacturer and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>.

	==== model ====		==== model ====
	==== engine ====		==== engine ====
	==== colour ====		==== colour ====

NPTracker: /* expired */

2019-04-12T08:02:12Z

expired

← Older revision		Revision as of 08:02, 12 April 2019
Line 66:		Line 66:
	==== external ====		==== external ====
	==== expired ====		==== expired ====
			If <u>true</u> then the date on the licence disk have expired, else <u>false</u> ie. disk is still valid.

	==== manufacturer ====		==== manufacturer ====
	==== model ====		==== model ====
	==== engine ====		==== engine ====
	==== colour ====		==== colour ====

NPTracker: /* np_tracker */

2019-04-12T07:58:49Z

np_tracker

← Older revision		Revision as of 07:58, 12 April 2019
Line 62:		Line 62:
	=== 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>		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 ====

NPTracker: /* Output */

2019-04-12T07:58:17Z

Output

← Older revision		Revision as of 07:58, 12 April 2019
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 ====

NPTracker: /* VIN */

2019-04-12T07:11:14Z

VIN

← Older revision		Revision as of 07:11, 12 April 2019
Line 26:		Line 26:
	[[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.

	=== scan_plate ===		=== scan_plate ===
	=== scan_manuf ===		=== scan_manuf ===

NPTracker: /* unlock */

2019-04-12T06:55:03Z

unlock

← Older revision		Revision as of 06:55, 12 April 2019
Line 42:		Line 42:
	=== TokensLeft ===		=== TokensLeft ===
	=== unlock ===		=== unlock ===
			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.

	=== checks ===		=== checks ===
	==== np_tracker ====		==== np_tracker ====

NPTracker at 09:44, 11 April 2019

2019-04-11T09:44:52Z

← Older revision		Revision as of 09:44, 11 April 2019
Line 1:		Line 1:
	{{~~warning~~\|1=This is the developer's corner to aid in integrating our RESTfull API into their apps.}}		{{#seo:
			\|title=API
			\|titlemode=append
			\|keywords=API, NPS-LIC, Motor Vehicle Licence Disk, Motor vehicle licence, barcode
			\|description=API interface to decode and test South African Motor Vehicle Licence Disk barcodes
			}}
			{{API\|1=This is the developer's corner to aid in integrating our RESTfull API into their apps.}}
	== Interface ==		== Interface ==
	This is a [[REST API]] endpoint using HTTP GET.<br>		This is a [[REST API]] endpoint using HTTP GET.<br>