CustomerLink Test Page
BuildingLink web service for customers. This is a private service restricted to BuildingLink customers only.
The following operations are supported. For a formal definition, please review the Service Description.
-
AddMaintenanceRequest1
Adds a single maintenance request for a specific unit for a specific building.- MaintenanceRequestBuildingId (Required if subsequent field is NULL)
- The Record ID# of this building by which we recognize which Building this request is for.
- Either this field (MaintenanceRequestBuildingID) or the subesquent field (MaintenanceRequestBuildingAccountNumber) is required. If both are provided and exist, Id overrides AccountNumber.
- MaintenanceRequestBuildingAccountNumber (Required if preceding field is NULL)
- Account# of this building (from the Bldg Account field in the Building Setup record) by which we recognize which Building this request is for.
- Either this field (MaintenanceRequestBuildingAccountNumber) or the preceding field (MaintenanceRequestBuildingID) is required. If both are provided and exist, Id overrides AccountNumber.
- MaintenanceRequestUnitId (Required if subsequent field is NULL)
- The Record ID# of this unit by which we recognize which Unit this request is for.
- Either this field (MaintenanceRequestUnitID) or the subesquent field (MaintenanceRequestUnitAccountNumber) is required. If both are provided and exist, Id overrides AccountNumber.
- MaintenanceRequestUnitAccountNumber (Required if previous field is NULL)
- The Account# of this Unit (from the Account field in the Unit Profile record) by which we recognize which Unit this request is for.
- Either this field (MaintenanceRequestUnitAccountNumber) or the preceding field (MaintenanceRequestUnitID) is required. If both are provided and exist, Id overrides AccountNumber.
- MaintenanceRequestCategoryId (Required)
- A value from the list of Maintenance categories that are valId for this building
- MaintenanceRequestEquipmentId (Optional)
- A value from the list of Equipment items that are valId for this building. <NULL> = NULL.
- MaintenanceRequestStatusId (Required)
- 1 = Open, 2 = On Hold, 3 = Closed
- MaintenanceRequestDescription (Required)
- Maximum 500 characters
- MaintenanceRequestOpenDate (Optional)
- <NULL> to insert the current date and time, or specify a valId date(no time) instead.
- It is recommended that the <NULL> value be used here whenever possible, that proper time and time zone data can be calculated)
- MaintenanceRequestUrgencyId (Required)
- 0 = High, 1 = Low
- MaintenanceRequestPriorityLevel (Optional)
- Maximum 2 characters (do not have to be numeric). <NULL> = NULL
- MaintenanceRequestHoldUntilDate (Optional)
- <NULL> = NULL otherwise must be a date (no time)
- MaintenanceRequestContactEmailAddress (Optional)
- Max 100 characters. <NULL> = NULL/li>
- MaintenanceRequestContactPhoneNumber (Optional)
- Max 80 characters (do not have to be numeric) <NULL> = NULL
- MaintenanceRequestPermissionToEnter (Optional)
- 0 = No, 1 = Yes, <NULL> = NULL
- MaintenanceRequestEntryInstructions (Optional)
- Max 1000 characters, <NULL> = NULL
- MaintenanceRequestOptionalReferenceNumber (Optional)
- Max 6 characters (do not have to be numeric). <NULL> = NULL
- Return the following fields:
- MaintenanceRequestInternalID
- MaintenanceRequestExternalID
- MaintenanceRequestContactEmailAddress
- MaintenanceRequestContactPhoneNumber
- BuildingMaintenanceRequestNotificationEmailAddress
- UnitMaintenanceRequestNotificationOn
-
GetEvents1
Gets (from the Event Log) either a single event or all events for a specific unit for a specific building. The following filter options are provided to further limit which events are returned: Event status, opened date range and closed date range.
To specify the building, use either the BuildingId parameter or the BuildingAccountNumber parameter and set the other field to 0 (zero). If both parameters are provided, the BuildingId parameter will override the BuildingAccountNumber parameter. The same holds true for Units (use either the Id or the Account #). Specify the EventId of the specific event you want to return, or to return all events (that meet the other filter criteria) instead of a specific one, set the EventId property to 0. The EventStatusId property expects one or more numeric status IDs delimited by commas (1=Open 0=Closed). The opened date range applies to all events while the closed date range applies only to closed events and is ignored for open events. Set any of the date parameters to 0 if it is not needed. In addition to the Event data, this method also returns basic building and unit information along with the events as a DataSet (including schema). -
GetMaintenanceRequestCategories1
Gets either a single maintenance request category or all categories, for a specific building. This method should be used when creating a selection list of categories. The category name is typically returned with other methods in order to reduce the number of calls you will have to make to the server.
To return all categories, set the CategoryId property to 0. To choose a building use either the BuildingId parameter or the BuildingAccountNumber parameter and set the other field to 0. If both parameters are provided the BuildingId parameter will override the BuildingAccountNumber parameter.
Note: A category can have a category-specific notification e-mail address that overrides the building's default maintenance request notification e-mail address. In order for the override address to be active, both the BuildingMaintenanceRequestCategoryOverrideEmailAddressIsActive field and the MaintenanceRequestCategoryOverrideEmailAddressIsActive field need to be "true". -
GetMaintenanceRequestsAndActions1
Gets either a single maintenance request and its related actions or all maintenance requests and their actions, for a specific unit for a specific building. The following filter options are provided to further limit which events are returned: Request status, opened date range and closed date range.
To specify the building, use either the BuildingId parameter or the BuildingAccountNumber parameter and set the other field to 0 (zero). If both parameters are provided, the BuildingId parameter will override the BuildingAccountNumber parameter. The same holds true for Units (use either the Id or the Account #). Specify the MaintenanceRequestId of the specific request you want to return, or to return all requests (that meet the other filter criteria) instead of a specific one, set the MaintenanceRequestId property to 0. The RequestStatusId property expects one or more numeric status IDs delimited by comas (1=Open 2=On Hold 3=Closed). The opened date range applies to all requests, while the closed date range applies only to closed maintenance requests and is ignored for requests that are open or on hold. Set any of the date parameters to 0 if it is not needed. In addition to the Request data, this method returns basic building and unit information along with the maintenance requests and their actions as a DataSet (including schema). -
GetUnit1
Gets unit profile information for a single unit for a specific building.
To specify the building, use either the BuildingId parameter or the BuildingAccountNumber parameter and set the other field to 0 (zero). If both parameters are provided, the BuildingId parameter will override the BuildingAccountNumber parameter. The same holds true for Units (use either the Id or the Account #). In addition to the Unit data, this method also returns basic building information as a DataSet (including schema). - HelloWorld