MonthlyContact1 will allows the end-user to add contact(s) to an existing monthly account that was created with any of the MonthlyAccount methods. This will be where the parkers details are submitted, including RFID number for entry credentials.
Request #
Example #
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://kleverlogic.com/webservices/">
<soapenv:Header/>
<soapenv:Body>
<web:MonthlyContact>
<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:contactID>CONTACT_ID</web:contactID>
<web:primaryContact>PRIMARY_CONTACT</web:primaryContact>
<web:firstName>FIRST_NAME</web:firstName>
<web:lastName>LAST_NAME</web:lastName>
<web:emailAddress>EMAIL_ADDRESS</web:emailAddress>
<web:mobileNumber>MOBILE_NUMBER</web:mobileNumber>
<web:customerBarcode>CUSTOMER_BARCODE</web:customerBarcode>
<web:RFIDNumber>RFID_NUMBER</web:RFIDNumber>
<web:employeeID>EMPLOYEE_ID</web:employeeID>
</web:MonthlyContact>
</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 contacts 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 contact for | string (GUID format) |
ACTION_TYPE | Yes | The action type can be one of three values: Add, Update, or DeleteAdd will create a new monthly contact with the details you provideUpdate will update the details of the monthly contactDelete will deactivate the monthly contact and clear access information as AVI Tag, Prox Card/RFID, The ID Card, the ID Tag, Decal, and PIN. | string (Add, Update, or Delete) |
ACCOUNT_NUMBER | 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 |
CONTACT_ID | Yes | You will provide a contact ID 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 |
PRIMARY_CONTACT | Yes | PRIMARY_CONTACT can be one of two values: 0 or 1
Note that only one primary contact per account is allowed. | integer (0 or 1) |
FIRST_NAME | Yes | The first name of the contact | string |
LAST_NAME | Yes | The last name of the contact | string |
EMAIL_ADDRESS | An email address for the contact. Note: Can be left blank. This field is not required. Not entering information in this field will not replace an existing email address with a blank field. If invalid values are entered in this field, the call with return an error response. | string (email address format) | |
MOBILE_NUMBER | A phone number for the contact (you may determine what format you wish to save the MOBILE_NUMBER value in). Note: Can be left blank. This field is not required. Not entering information in this field will not replace an existing mobile number with a blank field. If invalid values are entered in this field, the call with return an error response. You will be unable to enter a MOBILE_NUMBER that already exists, except at Texas Medical Center (TMC). | string | |
CUSTOMER_BARCODE | A bar code number to be used by the contact to enter and exit the parking facility. Note that use of bar codes requires certain configuration on a per location basis. Feel free to reach out to us for more information. | string | |
RFID_NUMBER | 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:77777Note: 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) | |
EMPLOYEE_ID | An employee ID used by the company to identify an employee | 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>
<MonthlyContactResponse xmlns="http://kleverlogic.com/webservices/">
<MonthlyContactResult>
<Code>RESULT_CODE</Code>
<Message>RESULT_MESSAGE</Message>
</MonthlyContactResult>
</MonthlyContactResponse>
</soap:Body>
</soap:Envelope>
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.