GetMonthlyVehicle1 will return the vehicle details that was created using the MonthlyVehicle endpoint. If the monthly account has multiple Vehicles and detail is needed for all linked Vehicles, then the endpoint will be used per Vehicle. This call can be used for all types of accounts: Monthly, Membership, Residential, and Master Accounts.
GET #
GET /api/monthly/GetMonthlyVehicle1 #
securityToken: string (GUID format)locationID: string (GUID format)
accountNumberType: string
accountNumber: string
vehicleIdType: string
vehicleId: string
Parameters #
| Value | Required Field | Description | Data Type |
securityToken | 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 accounts for. | string (GUID format) |
locationID | Yes | We provide you with a location ID in GUID format. The location ID corresponds with the location you are creating monthly accounts for | string (GUID format) |
accountNumberType | When passing through this value it will identify whether or not the Account Number being passed through is the Third Party System Generated Unique Value or the Flash Account number. | string | |
accountNumber | Yes | Third Party system generated unique value. This can match the account number in your system. This account number is external and different from the internal account number generated by the Flashparking system. | string |
vehicleIdType | When passing through this value it will identify whether or not the VehicleID being passed through is the Third Party System Generated Unique Value or the Flash Account number. | string | |
vehicleId | Yes | Third Party system generated vehicle unique value. This can match the account number in your system. This vehicle number is external and different from the internal vehicle GUID generated by the Flashparking system. | string |
Response #
Example #
{
"AccountNumber": "string",
"AccountID": "00000000-0000-0000-0000-000000000000",
"KeyBarcode": "string",
"KeyHook": "string",
"ParkingSpot": "string",
"RFIDNumber": "string",
"VehicleBarcode": "string",
"VehicleColor": "string",
"VehicleID": "string",
"ExternalVehicleID": "string",
"VehicleLicenseNumber": "string",
"VehicleLicenseState": "string",
"VehicleMake": "string",
"VehicleModel": "string",
"VehicleNickname": "string",
"Code": "Success",
"Message": "string"
}
Parameters #
The response should include a GetMonthlyVehicle1 object with the following data:
| Field | Description |
AccountNumber | The account number as shown on your platform. |
AccountID | The ID associated with the account. |
KeyBarcode | The bar code value associated with the keys. |
KeyHook | Valet’s key hook. |
ParkingSpot | Parking spot assigned if the facility uses assigned spots. |
RFIDNumber | An RFID number associated with the vehicle for a long range reader such as Tag Master. |
VehicleBarcode | The bar code value associated with the vehicle. |
VehicleColor | The vehicle color. |
VehicleID | You will provide an identifier for the vehicle. |
ExternalVehicleID | The external vehicle ID. |
VehicleLicenseNumber | The license plate number for the vehicle. |
VehicleLicenseState | The two letter abbreviation for the state the license plate was issued in. |
VehicleMake | The vehicle make. |
VehicleModel | The vehicle model. |
VehicleNickname | The nickname for the vehicle so that it can be easily distinguished by valet staff. |
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. |