Road Protect API: Specification summary

Formats & Dates

Please use ISO standard dates for working with the API. This is an internationally accepted format that provides the least date parsing errors in our system

Documentation on the format: https://www.w3.org/TR/NOTE-datetime
Example: YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)

In some cases, such as in queries, simpler YYYY-MM-DD formats are sufficient

Example: YYYY-MM-DD (1997-07-16)

Contact Us

Contact:Kerren [English Only]
Contact:Ore [Hebrew / English]

Documents & Files

Description	HTTP Request
Create document	POST /fleet.roadprotect.co.il/api/v1/document
Get document by DocumentId	GET /fleet.roadprotect.co.il/api/v1/document/{documentId}
Update document by DocumentId	POST /fleet.roadprotect.co.il/api/v1/document/{documentId}

Nominations

Description	HTTP Request
Batch digital redirection of nominations	POST /fleet.roadprotect.co.il/api/v1/nomination/batch/redirect/digital
Batch municipally redirect infringement	POST /fleet.roadprotect.co.il/api/v1/nomination/batch/redirect/municipal
Digitally redirect of nomination	POST /fleet.roadprotect.co.il/api/v1/nomination/{nominationId}/redirect/digital
Get Nomination by NominationId	GET /fleet.roadprotect.co.il/api/v1/nomination/{nominationId}
Manually update the status of the redirection	POST /fleet.roadprotect.co.il/api/v1/nomination/{nominationId}/redirect/approve
Municipally redirect infringement	POST /fleet.roadprotect.co.il/api/v1/nomination/{nominationId}/redirect/municipal
Query and filter nominations	GET /fleet.roadprotect.co.il/api/v1/query/nomination
Query and filter nominations as a spreadsheet	POST /fleet.roadprotect.co.il/api/v1/query/nomination/spreadsheet

Accounts

Description	HTTP Request
Create account [Deprecating - V1]	POST /fleet.roadprotect.co.il/api/v1/account
Create account [Phasing In - V2]	POST /fleet.roadprotect.co.il/api/v1/account/v2
Get an account by accountId	GET /fleet.roadprotect.co.il/api/v1/account/{accountId}
Get an account by identifier	GET /fleet.roadprotect.co.il/api/v1/account/brn/{identifier}
Get current [logged in] account details	GET /fleet.roadprotect.co.il/api/v1/account/me
Get short system account list	GET /fleet.roadprotect.co.il/api/v1/account/dropdown
Query and filter accounts	GET /fleet.roadprotect.co.il/api/v1/query/account
Query and filter accounts as a spreadsheet	POST /fleet.roadprotect.co.il/api/v1/query/account/spreadsheet
Update account by accountId [Deprecating - V1]	POST /fleet.roadprotect.co.il/api/v1/account/{accountId}
Update account by accountId [Phasing In - V2]	POST /fleet.roadprotect.co.il/api/v1/account/v2/{accountId}

Vehicles

Description	HTTP Request
Create vehicle	POST /fleet.roadprotect.co.il/api/v1/vehicle
Delete vehicle	DELETE /fleet.roadprotect.co.il/api/v1/vehicle/{vehicleId}
Edit vehicle	POST /fleet.roadprotect.co.il/api/v1/vehicle/{vehicleId}
Get vehicle	GET /fleet.roadprotect.co.il/api/v1/vehicle/{vehicleId}
Query and filter vehicles	GET /fleet.roadprotect.co.il/api/v1/query/vehicle
Query and filter vehicles as a spreadsheet	POST /fleet.roadprotect.co.il/api/v1/query/vehicle/spreadsheet

Contracts

Description	HTTP Request
Create document and perform OCR	POST /fleet.roadprotect.co.il/api/v1/contract/ocr/file
Delete contract by contractId	DELETE /fleet.roadprotect.co.il/api/v1/contract/{contractId}
Get contract (either lease / ownership) by contractId	GET /fleet.roadprotect.co.il/api/v1/contract/{contractId}
Get contracts for a vehicle by vehicleId	GET /fleet.roadprotect.co.il/api/v1/contract/vehicle/{vehicleId}
Query and filter contracts	GET /fleet.roadprotect.co.il/api/v1/query/contract
Query and filter contracts as a spreadsheet	POST /fleet.roadprotect.co.il/api/v1/query/contract/spreadsheet
Update contract end date	POST /fleet.roadprotect.co.il/api/v1/contract/{contractId}/end-date
Update contract end date by reference	POST /fleet.roadprotect.co.il/api/v1/contract/reference/{reference}/end-date
Update contract reference by contractId	POST /fleet.roadprotect.co.il/api/v1/contract/{contractId}/reference

Infringements

Description	HTTP Request
Approve nomination for payment	POST /fleet.roadprotect.co.il/api/v1/infringement/{infringementId}/approve
Batch infringement approval for payment	POST /fleet.roadprotect.co.il/api/v1/infringement/batch/approve
Check if infringement has required documentation for municipal redirection	GET /fleet.roadprotect.co.il/api/v1/infringement/{infringementId}/redirection-readiness
Check if infringements have required documentation for municipal redirection	POST /fleet.roadprotect.co.il/api/v1/infringement/batch/redirection-readiness
Get infringement by Infringement Id	GET /fleet.roadprotect.co.il/api/v1/infringement/{infringementId}
Query and filter infringements	GET /fleet.roadprotect.co.il/api/v1/query/infringement
Query and filter infringements as a spreadsheet	POST /fleet.roadprotect.co.il/api/v1/query/infringement/spreadsheet
Unapproved infringement for payment	POST /fleet.roadprotect.co.il/api/v1/infringement/{infringementId}/unapprove
Update infringement	POST /fleet.roadprotect.co.il/api/v1/infringement/{infringementId}

Lease Contracts

Description	HTTP Request
Create lease contract	POST /fleet.roadprotect.co.il/api/v1/lease-contract
Get lease contract	GET /fleet.roadprotect.co.il/api/v1/lease-contract/{contractId}

Ownership Contracts

Description	HTTP Request
Create ownership contract	POST /fleet.roadprotect.co.il/api/v1/ownership-contract
Get ownership contract by Id	GET /fleet.roadprotect.co.il/api/v1/ownership-contract/{contractId}