MonthlyVehicle (REST)

MonthlyVehicle allows the end-user to add vehicle(s) to an existing monthly account created with any of the MonthlyAccount methods. Vehicle details will be defined here. Such as license plate, make, and model.

Request #

Example #

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://kleverlogic.com/webservices/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:MonthlyVehicle>
      <web:securityToken>YOUR_SECURITY_TOKEN</web:securityToken>
      <web:locationID>LOCATION_ID</web:locationID>
      <web:actionType>ACTION_TYPE</web:actionType>
      <web:accountNumber>ACCOUNT_NUMBER</web:accountNumber>
      <web:vehicleID>VEHICLE_ID</web:vehicleID>
      <web:vehicleNickname>VEHICLE_NICKNAME</web:vehicleNickname>
      <web:vehicleMake>VEHICLE_MAKE</web:vehicleMake>
      <web:vehicleModel>VEHICLE_MODEL</web:vehicleModel>
      <web:vehicleColor>VEHICLE_COLOR</web:vehicleColor>
      <web:vehicleLicenseState>VEHICLE_LICENSE_STATE</web:vehicleLicenseState>
      <web:vehicleLicenseNumber>VEHICLE_LICENSE_NUMBER</web:vehicleLicenseNumber>
      <web:keyBarcode>KEY_BARCODE</web:keyBarcode>
      <web:vehicleBarcode>VEHICLE_BARCODE</web:vehicleBarcode>
      <web:keyhook>KEY_HOOK</web:keyhook>
      <web:RFIDNumber>RFID_NUMBER</web:RFIDNumber>
      <web:parkingSpot>PARKING_SPOT</web:parkingSpot>
    </web:MonthlyVehicle>
  </soapenv:Body>
</soapenv:Envelope>

Parameters #

Value	Required Field	Description	Data Type
YOUR_SECURITY_TOKEN	Yes	We provide you with a security token in GUID format Note that this security token will differ from location to location. Your security token for the Monthly API is not used globally across all locations. We will provide you with a different security token per each location you create monthly vehicles for	string(GUID format)
LOCATION_ID	Yes	We provide you with a location ID in GUID format. The location ID corresponds with the location you are creating the monthly vehicle for	string(GUID format)
ACTION_TYPE	Yes	The action type can be one of three values: add, update, or delete add will create a new monthly vehicle with the details you provide update will update the details of the monthly vehicle delete will deactivate the monthly vehicle	string(add, update, or delete)
ACCOUNT_NUMBER	Yes	You will provide an account number of the account you are adding the vehicle to. This must match the account number provided when creating the account using the MonthlyAccount call	string
VEHICLE_ID	Yes	You will provide an identifier for the vehicle	string
VEHICLE_NICKNAME	Yes	A nickname for the vehicle so that it can be easily distinguished by valet staff	string (10 character limit)
VEHICLE_MAKE		The vehicle make	string
VEHICLE_MODEL		The vehicle model	string
VEHICLE_COLOR		The vehicle color	string
VEHICLE_LICENSE_STATE		The two letter abbreviation for the state the license plate was issued in	string
VEHICLE_LICENSE_NUMBER		The license plate number for the vehicle	string
KEY_BARCODE		The bar code value associated with the keys (for valet purposes)	string
VEHICLE_BARCODE		The bar code value associated with the vehicle (for valet purposes)	string
KEY_HOOK		Valet only	string
RFID_NUMBER		An RFID number associated with the vehicle for a long range reader such as Tag Master. Include the facility code and the card ID. For example, if a card has facility code 111 and a card ID of 77777, you would provide the value as 111:77777	string (50 character limit)
PARKING_SPOT		If the parking facility uses assigned spots, provide the identifying information for the spot the vehicle is allowed to park in	string

Response #

Example #

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <MonthlyVehicleResponse xmlns="http://kleverlogic.com/webservices/">
      <MonthlyVehicleResult>
        <Code>RESULT_CODE</Code>
        <Message>RESULT_MESSAGE</Message>
      </MonthlyVehicleResult>
    </MonthlyVehicleResponse>
  </soap:Body>
</soap:Envelope>

Parameters #

The response should include a MonthlyVehicleResult object with the following data:

Field	Description
Code	If the request succeeded, the value of RESULT_CODE will be Success. If the request failed, a relevant error code will be provided.
Message	A message with clarifying information about the result is provided in this field