GetMonthlyContact1 will return the details of the contact that was created using the MonthlyContact endpoint. If the monthly account has multiple contacts and detail is needed for all linked contacts, then the endpoint will be used per contact. This call can be used for all types of accounts: Monthly, Membership, Residential, and Master Accounts.
GET #
GET /api/monthly/GetMonthlyContact1 #
securityToken:string(GUID format)
locationID:string(GUID format)
accountNumberType: string
accountNumber: string
contactIDType: string
contactID: 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 | Yes | 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 Flash system. | string |
contactIDType | Yes | When passing through this value it will identify whether or not the ContactID Number being passed through is the Third Party System Generated Unique Value or the Flash Account number. | string |
contactID | Yes | Third Party system generated contact unique value. This can match the account number in your system. This contact number is external and different from the internal contact GUID generated by the Flash system. | string |
Response #
Example #
{
"LocationId": "string",
"ContactGuid": "00000000-0000-0000-0000-000000000000",
"ExternalId": "string",
"MonthlyAccountExternalId": "string",
"MonthlyAccountGuid": "00000000-0000-0000-0000-000000000000",
"MonthlyAccountNumber": 0,
"PrimaryContact": true,
"FirstName": "string",
"LastName": "string",
"EmailAddress": "string",
"MobileNumber": "string",
"CustomerBarcode": "string",
"RFIDNumber": "string",
"EmployeeId": "string",
"AccountNumber": "string",
"ContactId": "string",
"Code": "Success",
"Message": "string"
}
Parameters #
The response should include a GetMonthlyContact1 object with the following data:
| Field | Description |
locationID | Location ID, GUID format. |
ContactGuid | Each contact has a unique GUID. |
ExternalId | Contact’s external ID. |
MonthlyAccountExternalId | Monthly account’s external ID. |
MonthlyAccountGuid | Each account has a unique GUID. |
MonthlyAccountNumber | Monthly account number generated by the system. |
PrimaryContact | 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. |
FirstName | The first name of the contact. |
LastName | The last name of the contact. |
EmailAddress | An email address for the contact. |
MobileNumber | A phone number for the contact. |
CustomerBarcode | A barcode number to be used by the contact to enter and exit the parking facility. The |
RFIDNumber | A proximity card number that can be used to enter and exit the parking facility. |
EmployeeId | An employee ID used by the company to identify an employee. |
AccountNumber | Account number of the account the contact belongs to. |
ContactId | ContactId associated with the contact created. This can match the contact ID in your system or in some cases a hotel room number. |
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 |