NPS-API - Revision history

NPTracker at 07:38, 31 May 2023

2023-05-31T07:38:20Z

← Older revision		Revision as of 07:38, 31 May 2023
Line 6:		Line 6:
	}}		}}
	[[File:Datasheet250.png\|200px\|thumb\|right\|Datasheet250 NPS-API NP Tracker suspect vehicle API interface]]<br>		[[File:Datasheet250.png\|200px\|thumb\|right\|Datasheet250 NPS-API NP Tracker suspect vehicle API interface]]<br>
	{{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.}}
	For a high speed client side application interface see our [[NPS-API Webservice]].		For a high-speed client-side application interface see our [[NPS-API Webservice]].
	== Interface ==		== Interface ==
	This is a [[REST API]] endpoint using HTTP GET.<br>		This is a [[REST API]] endpoint using HTTP GET.<br>
Line 13:		Line 13:
	== 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 ===
	==== cmd ====		==== cmd ====
Line 54:		Line 54:

	=== response_ms ===		=== response_ms ===
	Show the ~~scripts~~ response time in ~~milli seconds~~ from initial request to display of results.		Show the script's response time in milliseconds from the initial request to the display of results.

	=== plate ===		=== plate ===
Line 60:		Line 60:

	=== desc ===		=== desc ===
	The Vehicle lookout report as per the NP Tracker dataset.<br>		The Vehicle lookout report is as per the NP Tracker dataset.<br>
	Report length can be trimmed to a specified length with the <u>trim</u> ~~pagameter~~.<br>		Report length can be trimmed to a specified length with the <u>trim</u> parameter.<br>
	Each message picked up will be delimited with '''<strong>@</strong>'''.		Each message picked up will be delimited with '''<strong>@</strong>'''.

NPTracker at 06:00, 18 April 2019

2019-04-18T06:00:47Z

← Older revision		Revision as of 06:00, 18 April 2019
Line 7:		Line 7:
	[[File:Datasheet250.png\|200px\|thumb\|right\|Datasheet250 NPS-API NP Tracker suspect vehicle API interface]]<br>		[[File:Datasheet250.png\|200px\|thumb\|right\|Datasheet250 NPS-API NP Tracker suspect vehicle API interface]]<br>
	{{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 RESTfull API into their apps.}}
			For a high speed client side application interface see our [[NPS-API Webservice]].
	== Interface ==		== Interface ==
	This is a [[REST API]] endpoint using HTTP GET.<br>		This is a [[REST API]] endpoint using HTTP GET.<br>
	Available to any device/server on the internet.		Available to any device/server on the internet.<br>
	== 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>

NPTracker: /* result */

2019-04-12T06:48:48Z

result

← Older revision		Revision as of 06:48, 12 April 2019
Line 70:		Line 70:

	=== result ===		=== result ===
			Always returns a true.

	=== version ===		=== version ===
	The version of the API endpoint.		The version of the API endpoint.

NPTracker: /* version */

2019-04-12T06:48:12Z

version

← Older revision		Revision as of 06:48, 12 April 2019
Line 70:		Line 70:

	=== result ===		=== result ===
	=== version===		=== version ===
			The version of the API endpoint.

NPTracker: /* report_date */

2019-04-12T06:47:28Z

report_date

← Older revision		Revision as of 06:47, 12 April 2019
Line 67:		Line 67:

	=== report_date ===		=== report_date ===
			The timestamp of the first report for the vehicle.

	=== result ===		=== result ===
	=== version===		=== version===

NPTracker: /* last_date */

2019-04-12T06:46:57Z

last_date

← Older revision		Revision as of 06:46, 12 April 2019
Line 64:		Line 64:

	=== last_date ===		=== last_date ===
			The timestamp of the latest (last) report for the vehicle.

	=== report_date ===		=== report_date ===
	=== result ===		=== result ===
	=== version===		=== version===

NPTracker: /* desc */

2019-04-12T06:45:41Z

desc

← Older revision		Revision as of 06:45, 12 April 2019
Line 61:		Line 61:
	The Vehicle lookout report as per the NP Tracker dataset.<br>		The Vehicle lookout report as per the NP Tracker dataset.<br>
	Report length can be trimmed to a specified length with the <u>trim</u> pagameter.<br>		Report length can be trimmed to a specified length with the <u>trim</u> pagameter.<br>
	Each message picked up will be delimited with ''@''.		Each message picked up will be delimited with '''<strong>@</strong>'''.

	=== last_date ===		=== last_date ===

NPTracker: /* desc */

2019-04-12T06:45:05Z

desc

← Older revision		Revision as of 06:45, 12 April 2019
Line 59:		Line 59:

	=== desc ===		=== desc ===
			The Vehicle lookout report as per the NP Tracker dataset.<br>
			Report length can be trimmed to a specified length with the <u>trim</u> pagameter.<br>
			Each message picked up will be delimited with ''@''.

	=== last_date ===		=== last_date ===
	=== report_date ===		=== report_date ===
	=== result ===		=== result ===
	=== version===		=== version===

NPTracker: /* plate */

2019-04-12T06:17:33Z

plate

← Older revision		Revision as of 06:17, 12 April 2019
Line 56:		Line 56:

	=== plate ===		=== plate ===
	The vehicle number plate the report will relate to		The vehicle number plate the report will relate to.

	=== desc ===		=== desc ===

NPTracker: /* plate */

2019-04-12T06:17:18Z

plate

← Older revision		Revision as of 06:17, 12 April 2019
Line 56:		Line 56:

	=== plate ===		=== plate ===
			The vehicle number plate the report will relate to

	=== desc ===		=== desc ===
	=== last_date ===		=== last_date ===