MonthlyContact2 (REST)

MonthlyContact2 will allow the end-user to add contact(s) to an existing monthly account that was created with any of the MonthlyAccount endpoints. This will be where the parkers details are submitted, including RFID numbers for entry credentials.

The main differentiator between this call and MonthlyContact1 is that this call will clear out the EmailAddress and MobileNumber values on an existing contact if the fields are left blank.

POST #

POST /api/monthly/MonthlyContact2 #

securityToken: “string”

{
  "AccountNumber": "string",
  "ActionType": "Add",
  "ContactId": "string",
  "CustomerBarcode": "string",
  "EmailAddress": "string",
  "EmployeeId": "string",
  "FirstName": "string",
  "LastName": "string",
  "MobileNumber": "string",
  "PrimaryContact": true,
  "RfidNumber": "string",
  "LocationId": "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 contacts for.	string (GUID format)
AccountNumber	Yes	You will provide an account number of the account you are adding the contact to. This must match the account number provided when creating the account using the MonthlyAccount call.	string
ActionType	Yes	The action type can be one of three values: Add, Update, or Delete (case-sensitive) Add will create a new monthly contact with the details you provide. Update will update the details of the monthly contact. Delete will deactivate the monthly contact and clear contact information as Prox Card/RFID, The ID Card, the ID Tag, Decal, and PIN.	string (Add, Update, or Delete)
ContactId	Yes	You will provide a ContactId to associate with the contact you are creating. This can match the contact ID in your system or in some cases a hotel room number.	string
CustomerBarcode		A barcode number to be used by the contact to enter and exit the parking facility. The CustomerBarcode field maps to ID Card field in the Admin Portal. Note that the use of barcodes requires certain configurations on a per-location basis. Feel free to reach out to us for more information.	string
EmailAddress		An email address for the contact. Note: This field is not required, however, if left blank or the value is absent then the email address on the contact will be deleted. If invalid values are entered in this field, the call with return an error response.	string (email address format)
EmployeeId		An employee ID used by the company to identify an employee.	string
FirstName	Yes	The first name of the contact.	string
LastName	Yes	The last name of the contact.	string
MobileNumber		A phone number for the contact (you may determine what format you wish to save the MobileNumber value in). Note: This field is not required, however, if left blank or the value is absent then the mobile number on the contact will be deleted. If invalid values are entered in this field, the call with return an error response.	string
PrimaryContact	Yes	PrimaryContact can be one of two values: true or false false, meaning that this will not be the primary contact for the account and the contact will not be able to make changes to the account. true, meaning that this will be the primary contact for the account and the contact will be able to make changes to the account. Note that only one primary contact per account is allowed.	boolean (true or false)
RfidNumber		A proximity card number that can be used to enter and exit the parking facility. Include the facility code and the card ID. For example, if a card has a facility code 111 and a card ID of 77777, you would provide the value as 111:77777 Note: This number CAN’T BE DUPLICATED within the same location. If this number already exists on any account on the current location the system will return the following error msg “RFID Tag Already Exists“.	string (50 character limit)
LocationId	Yes	We provide you with a location ID in GUID format. The location ID corresponds with the location you are creating the monthly contact for.	string (GUID format)

Response #

Example #

{
  "Code": "Success",
  "Message": "string",
  "LocationProfiles": [
    {
      "UniqueID": "00000000-0000-0000-0000-000000000000",
      "Name": "string"
    }
  ]
}

Parameters #

The response should include a MonthlyContactResult 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

FAQ #

Will this allow the same RFID card number to be used on more than one contact in the same location? #

This call will not allow the use of the same RFID Card number on more than one contact on the same location. The Code in the response will be GeneralFailure and the Message will read RFID Tag already exists.