Update infringement

Request

POST http:///fleet.roadprotect.co.il/api/v1/infringement/{infringementId}

Path parameters

Request body

The request body takes a complete UpdateInfringementDto resource, containing the following writable properties:

{
    "amountDue": "string",
    "approvedDate": "string",
    "brn": "string",
    "caseNumber": "string",
    "dateRedirectionCompleted": "string",
    "infringementStatus": "string",
    "isExternal": "boolean",
    "issuer": "string",
    "issuerStatus": "string",
    "issuerStatusDescription": "string",
    "latestPaymentDate": "string",
    "nominationStatus": "string",
    "note": "string",
    "notes": [
        "string"
    ],
    "noticeNumber": "string",
    "offenceDate": "string",
    "originalAmount": "string",
    "paymentAmount": "number",
    "paymentDate": "string",
    "paymentReference": "string",
    "reason": "string",
    "reasonCode": "string",
    "redirectionIdentifier": "string",
    "redirectionLetterSendDate": "string",
    "redirectionReference": "string",
    "redirectionType": "string",
    "setRedirectionCompletionDate": "boolean",
    "setRedirectionIdentifier": "boolean",
    "timezone": "string",
    "type": "string"
}

Properties

Authorisation

To authenticate your client integration please put your token in the header of your requests with the key Authorization, it should look like this:

Authorization: Bearer YOUR_TOKEN_HERE

Please keep your token secured. If your token is compromised, we can issue a new token for you.

This request requires the use of one of following authorisation methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Example Request

NodeJs Request

For example, to update the case number: - Replace INFRINGMENT_ID with the desired infringementId. - Replace CASE_NUMBER with the desired caseNumber.

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'http://fleet.roadprotect.co.il/api/v1/infringement/INFRINGMENT_ID',
    'headers': {
        'Authorization': 'Bearer YOUR_TOKEN_HERE', 
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({"caseNumber":"'CASE_NUMBER'"})
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

Python Requests

For example, to update the case number: - Replace INFRINGMENT_ID with the desired infringementId. - Replace CASE_NUMBER with the desired caseNumber.

import requests
url = "http://fleet.roadprotect.co.il/api/v1/infringement/INFRINGMENT_ID"

payload="{\n    \"caseNumber\":\"'CASE_NUMBER'\"\n}"
headers = {
    'Authorization': 'Bearer YOUR_TOKEN_HERE',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)