Name | Description | Type | Additional information |
---|---|---|---|
CustomerSystemId |
Sedona internal autonumber for the AR Customer System record (AR_Customer_System table); required for PUT |
integer |
None. |
CSCustomerSystemId |
Sedona internal autonumber for the CS Customer System record (CS_Customer_System table); set automatically on POST/PUT |
integer |
None. |
CustomerId |
Foreign key from AR_Customer table |
integer |
Required |
CustomerNumber |
Customer Number the customer sees |
string |
None. |
CustomerName |
customer Name |
string |
None. |
CustomerSiteId |
Foreign key from AR_Customer_Site table |
integer |
Required |
SiteAddress |
Site Address |
string |
None. |
SitePhone |
Site Phone |
string |
None. |
SitePhone2 |
Site Phone 2 |
string |
None. |
SystemCode |
Value from SY_System table; must be a valid value, and cannot be set to N/A; list of valid options can be retrieved from GET: api/systemtype |
string |
Required |
PanelTypeCode |
Value from SY_Panel_Type table; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/paneltype |
string |
None. |
PanelLocation |
Description of where the Panel is located |
string |
String length: inclusive between 0 and 50 |
Memo |
Miscellaneous memo (comment) field |
string |
String length: inclusive between 0 and 50 |
JobCode |
Value from OE_Job table; defaults to 000 if not supplied |
string |
None. |
ContractFormCode |
Value from AR_Contract_Form table; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/contractform |
string |
None. |
ContractNumber |
The number assigned to the Contract |
string |
String length: inclusive between 0 and 25 |
WarrantyCode |
Value from SV_Warranty table; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/warranty |
string |
None. |
ServiceLevelCode |
Value from SV_Service_Level table; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/servicelevel |
string |
None. |
ServiceLevelId |
Foreign key from SV_Service_Level table |
integer |
None. |
AlarmAccount |
Identifier for the Account number. It can contain the Alarm Monitoring number (CSID), or any other assigned identifier. Corresponds to the System Account in SedonaOffice. |
string |
String length: inclusive between 0 and 25 |
AlarmCompanyCode |
Value from CS_Alarm_Company table; Provider of the Monitoring Services for this System; defaults to N/A if not supplied. |
string |
None. |
ServiceCompanyCode |
Value from SV_Service_Company table; Provider of Service for this System; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/servicecompany |
string |
None. |
ServiceCompanyId |
Foreign key from SV_Service_Company table |
integer |
None. |
ContractStartDate |
Date the Contract starts (the Warranty will be calculated based upon this date). |
string |
None. |
Months |
Number of months for the initial term of the Contract; defaults to 0 if not supplied. |
integer |
None. |
RenewalMonths |
Number of months for the automatic renewal of the Contract; defaults to 0 if not supplied. |
integer |
None. |
InvoiceDescriptionId |
Value from AR_Invoice_Description table; set to 1 (N/A) if not applicable |
integer |
None. |
CyclePONumber |
PO number for Cycle Invoices for this System. |
string |
String length: inclusive between 0 and 25 |
CyclePOExpire |
Date the Cycle PO expires. |
string |
None. |
LastInspectionDate |
Date the last time the system was inspected |
string |
None. |
NextInspectionDate |
Date of the next scheduled inspection |
string |
None. |
InspectionNotes | string |
String length: inclusive between 0 and 1024 |
|
SystemComments |
General comment field for the System. |
string |
String length: inclusive between 0 and 1024 |
OkToIncrDate |
The date this system may be incremented. This supercedes the Customer level OK to Increment field. |
string |
None. |
WarrantyDate |
The date that the warranty will start on this system. |
string |
None. |
Inactive |
Set to true to make this system inactive; defaults to false if not supplied |
boolean |
None. |
PORequired |
Set to true if a PO is required for service |
boolean |
None. |
RouteId |
Value from SV_Routes table; defaults to 1 (N/A) if not supplied) |
integer |
None. |
TransmissionFormatId |
Value from CS_Transmission_Format table; defaults to N/A if not supplied. |
integer |
None. |
SystemPassword |
Password or code word customers call the Central Station with. |
string |
String length: inclusive between 0 and 25 |
DuressPassword |
Password or code word customers call the Central Station with when they are under duress. |
string |
String length: inclusive between 0 and 25 |
KeysOnFile |
Keys to the premise held by the alarm company. |
boolean |
None. |
KeyNumber |
Number or identifier the keys are filed under. |
string |
String length: inclusive between 0 and 15 |
ULGradeId |
Value from CS_UL_Grade table |
integer |
None. |
HasSounder |
System has a sounder |
boolean |
None. |
KeypadCode |
Code to be entered to disarm the alarm system |
string |
String length: inclusive between 0 and 10 |
PanelPhone |
The phone line connected for the panel, usually for remote downloading. |
string |
String length: inclusive between 0 and 12 |
CSPhone |
The number the panel is programmed to call at the central station. |
string |
String length: inclusive between 0 and 12 |
SecondaryAccount |
The Identifier for the secondary account number (i.e. radio back-up). It can contain the Alarm Monitoring number, or any other assigned identifier. |
string |
String length: inclusive between 0 and 25 |
SecondaryPanelTypeId |
Value from SY_Panel_Type table; set to 1 (N/A) if not applicable |
integer |
None. |
SecTransmissionFormatId |
Value from CS_Transmission_Format table; set to 1 (N/A) if not applicable |
integer |
None. |
EmergencyContacts |
Also known as Call List; only populate if using CustomerCA |
Collection of CustomerSystemCallList |
None. |
RecurLines |
List of Customer Recurring records for this system; only populate if using CustomerCA |
Collection of CustomerRecurring |
None. |
SystemCustomer |
Customer object associated with the Customer System reocrd. Use the CustomerSystemSearch object to include this in the result of api/customersystem/search action. |
Customer |
None. |
SystemSite |
Customer Site object associated with the Customer System reocrd. Use the CustomerSystemSearch object to include this in the result of api/customersystem/search action. |
CustomerSite |
None. |