Parking Ticket

getParkingTicket([, propertyNames])

Declaration

hmkit.commands.ParkingTicket.getParkingTicket()

Parameters

propertyNames

(optional) Array of names of the properties you want returned.

Returns

ParkingTicketResponse

Example

hmkit.telematics.sendCommand(
  hmkit.commands.ParkingTicket.getParkingTicket(),
  accessCertificate
);

ParkingTicketResponse

Parameters

status(Object)
data.value

(String) (enum)

timestamp

(Date)

operatorName(Object)
data.value

(String) Operator name

timestamp

(Date)

operatorTicketID(Object)
data.value

(String) Operator ticket ID

timestamp

(Date)

ticketStartTime(Object)
data.value

(Date) (timestamp) Parking ticket start time

timestamp

(Date)

ticketEndTime(Object)
data.value

(Date) (timestamp) Parking ticket end time

timestamp

(Date)

Example

{
  "status": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "ended"
    }
  },
  "operatorName": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "Berlin Parking"
    }
  },
  "operatorTicketID": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "6489AB4233"
    }
  },
  "ticketStartTime": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "2017-01-10T19:34:22.000Z"
    }
  },
  "ticketEndTime": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "2019-10-08T11:21:45.000Z"
    }
  }
}

getAvailability([, propertyNames])

Declaration

hmkit.commands.ParkingTicket.getAvailability()

Parameters

propertyNames

(optional) Array of names of the properties you want returned.

Example

// Get availability for all properties
hmkit.telematics.sendCommand(
  hmkit.commands.ParkingTicket.getAvailability(),
  accessCertificate
);
// Get availability for specific properties
hmkit.telematics.sendCommand(
  hmkit.commands.ParkingTicket.getAvailability(['status']),
  accessCertificate
);

Response

Parameters

availability(Object)
updateRate.value

(String) enum

rateLimit.value

(Number)

rateLimit.unit

(String)

appliesPer.value

(String)

Discussion

The response contains an availability object for each property, as shown in the example

Example

{
  "status": {
    "availability": {
      "updateRate": {
        "value": "trip_high"
      },
      "rateLimit": {
        "value": 64,
        "unit": "hertz"
      },
      "appliesPer": {
        "value": "vehicle"
      }
    }
  }
}

startParking({ operatorTicketID, ticketStartTime, operatorName, ticketEndTime })

Parameters

operatorTicketID

(String) Operator ticket ID

ticketStartTime

(Date) (timestamp) Parking ticket start time

operatorName

(String) Operator name

ticketEndTime

(Date) (timestamp) Parking ticket end time

Example

hmkit.telematics.sendCommand(
  hmkit.commands.ParkingTicket.startParking({
    "operatorTicketID": "6489AB4233",
    "ticketStartTime": "2017-01-10T19:34:22.000Z",
    "operatorName": "Berlin Parking",
    "ticketEndTime": "2019-10-08T11:21:45.000Z"
  }),
  accessCertificate
);

endParking()

Parameters

Example

hmkit.telematics.sendCommand(
  hmkit.commands.ParkingTicket.endParking({}),
  accessCertificate
);