POST api/Device/DeviceUpdate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ActionPlanSearch	string	None.
AltDeviceID	string	None.
AlternateTimerTestInterval	string	None.
AlternateTimerTestWhenDisarmFlag	boolean	None.
BillingID	string	None.
CommunicationType	string	None.
DeviceConfigOnlyFlag	boolean	None.
DeviceInfo	string	None.
DeviceIPAddress	string	None.
DeviceLocation	string	None.
DeviceType	string	None.
FailTTEventCode	string	None.
FirstSignalDate	date	None.
FirstSignalTime	string	None.
IVRNum	string	None.
LineSecurity	string	None.
ListenInDeviceType	string	None.
Password	string	None.
Port	integer	None.
PrimaryDevNum	integer	None.
ProcessSignalsOnPrimaryFlag	boolean	None.
SigForm	string	None.
SilentFlag	boolean	None.
SiteGroupNum	integer	None.
SiteType	string	None.
TimerTestAltHours	integer	None.
TimerTestAltMinutes	integer	None.
TimerTestDays	integer	None.
TimerTestHours	integer	None.
TimerTestMinutes	integer	None.
TimerTestNum	integer	None.
TransmitterCode	string	None.
URLTarget	string	None.
URLText	string	None.
UserName	string	None.
OOSCat	string	None.
ColumnIntegrationPlatform	string	None.
ColumnProgramLabel	string	None.
ColumnProgramPath	string	None.
ColumnProgramArgument	string	None.
ColumnEntryExitPeriod	string	None.
SiteGroupName	string	None.
DevNum	integer	None.
SiteNum	integer	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ActionPlanSearch": "sample string 1",
  "AltDeviceID": "sample string 2",
  "AlternateTimerTestInterval": "sample string 3",
  "AlternateTimerTestWhenDisarmFlag": true,
  "BillingID": "sample string 4",
  "CommunicationType": "sample string 5",
  "DeviceConfigOnlyFlag": true,
  "DeviceInfo": "sample string 6",
  "DeviceIPAddress": "sample string 7",
  "DeviceLocation": "sample string 8",
  "DeviceType": "sample string 9",
  "FailTTEventCode": "sample string 10",
  "FirstSignalDate": "2024-05-01T18:52:08.3250252-04:00",
  "FirstSignalTime": "sample string 11",
  "IVRNum": "sample string 12",
  "LineSecurity": "sample string 13",
  "ListenInDeviceType": "sample string 14",
  "Password": "sample string 15",
  "Port": 1,
  "PrimaryDevNum": 1,
  "ProcessSignalsOnPrimaryFlag": true,
  "SigForm": "sample string 16",
  "SilentFlag": true,
  "SiteGroupNum": 1,
  "SiteType": "sample string 17",
  "TimerTestAltHours": 1,
  "TimerTestAltMinutes": 1,
  "TimerTestDays": 1,
  "TimerTestHours": 1,
  "TimerTestMinutes": 1,
  "TimerTestNum": 1,
  "TransmitterCode": "sample string 18",
  "URLTarget": "sample string 19",
  "URLText": "sample string 20",
  "UserName": "sample string 21",
  "OOSCat": "sample string 22",
  "ColumnIntegrationPlatform": "sample string 23",
  "ColumnProgramLabel": "sample string 24",
  "ColumnProgramPath": "sample string 25",
  "ColumnProgramArgument": "sample string 26",
  "ColumnEntryExitPeriod": "sample string 27",
  "SiteGroupName": "sample string 28",
  "DevNum": 1,
  "SiteNum": 1,
  "SessionNum": 29,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 30",
  "StagesURL": "sample string 31"
}

application/xml, text/xml

Sample:

<DeviceDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 31</StagesURL>
  <ApplicationCode>sample string 30</ApplicationCode>
  <SessionNum>29</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <SiteNum>1</SiteNum>
  <DevNum>1</DevNum>
  <ActionPlanSearch>sample string 1</ActionPlanSearch>
  <AltDeviceID>sample string 2</AltDeviceID>
  <AlternateTimerTestInterval>sample string 3</AlternateTimerTestInterval>
  <AlternateTimerTestWhenDisarmFlag>true</AlternateTimerTestWhenDisarmFlag>
  <BillingID>sample string 4</BillingID>
  <ColumnEntryExitPeriod>sample string 27</ColumnEntryExitPeriod>
  <ColumnIntegrationPlatform>sample string 23</ColumnIntegrationPlatform>
  <ColumnProgramArgument>sample string 26</ColumnProgramArgument>
  <ColumnProgramLabel>sample string 24</ColumnProgramLabel>
  <ColumnProgramPath>sample string 25</ColumnProgramPath>
  <CommunicationType>sample string 5</CommunicationType>
  <DeviceConfigOnlyFlag>true</DeviceConfigOnlyFlag>
  <DeviceIPAddress>sample string 7</DeviceIPAddress>
  <DeviceInfo>sample string 6</DeviceInfo>
  <DeviceLocation>sample string 8</DeviceLocation>
  <DeviceType>sample string 9</DeviceType>
  <FailTTEventCode>sample string 10</FailTTEventCode>
  <FirstSignalDate>2024-05-01T18:52:08.3250252-04:00</FirstSignalDate>
  <FirstSignalTime>sample string 11</FirstSignalTime>
  <IVRNum>sample string 12</IVRNum>
  <LineSecurity>sample string 13</LineSecurity>
  <ListenInDeviceType>sample string 14</ListenInDeviceType>
  <OOSCat>sample string 22</OOSCat>
  <Password>sample string 15</Password>
  <Port>1</Port>
  <PrimaryDevNum>1</PrimaryDevNum>
  <ProcessSignalsOnPrimaryFlag>true</ProcessSignalsOnPrimaryFlag>
  <SigForm>sample string 16</SigForm>
  <SilentFlag>true</SilentFlag>
  <SiteGroupName>sample string 28</SiteGroupName>
  <SiteGroupNum>1</SiteGroupNum>
  <SiteType>sample string 17</SiteType>
  <TimerTestAltHours>1</TimerTestAltHours>
  <TimerTestAltMinutes>1</TimerTestAltMinutes>
  <TimerTestDays>1</TimerTestDays>
  <TimerTestHours>1</TimerTestHours>
  <TimerTestMinutes>1</TimerTestMinutes>
  <TimerTestNum>1</TimerTestNum>
  <TransmitterCode>sample string 18</TransmitterCode>
  <URLTarget>sample string 19</URLTarget>
  <URLText>sample string 20</URLText>
  <UserName>sample string 21</UserName>
</DeviceDetailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DeviceUpdateQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of DeviceUpdateResult	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "ActionPlanSearch": "sample string 1",
      "ActPlanDescription": "sample string 2",
      "AltDeviceID": "sample string 3",
      "AlternateTimerTestInterval": "sample string 4",
      "AlternateTimerTestWhenDisarmFlag": true,
      "ApplicationNum": 1,
      "BillingID": "sample string 5",
      "CommunicationType": "sample string 6",
      "CommunicationTypeDescription": "sample string 7",
      "CustomOption": "sample string 8",
      "DefaultFailTimerTestEvent": "sample string 9",
      "DefaultTimerTestDescription": "sample string 10",
      "DeviceConfigOnlyFlag": true,
      "DeviceInfo": "sample string 11",
      "DeviceIPAddress": "sample string 12",
      "DeviceLocation": "sample string 13",
      "DeviceType": "sample string 14",
      "DeviceTypeDescription": "sample string 15",
      "DevNum": 1,
      "EntryExitPeriod": "sample string 16",
      "EventCodeDescription": "sample string 17",
      "FailTTEventCode": "sample string 18",
      "FirstSignalDate": "2024-05-01T18:52:08.3250252-04:00",
      "FirstSignalTime": "sample string 19",
      "FunctionOption": "sample string 20",
      "HasDeviceFlag": true,
      "InServiceDate": "2024-05-01T18:52:08.3250252-04:00",
      "IntegrationPlatform": "sample string 21",
      "IntegrationPlatformDescription": "sample string 22",
      "IVRNum": "sample string 23",
      "LastSignalDate": "2024-05-01T18:52:08.3250252-04:00",
      "LineSecurity": "sample string 24",
      "ListenInDeviceType": "sample string 25",
      "ListenInDeviceTypeDescription": "sample string 26",
      "OOSCat": "sample string 27",
      "OOSCatDescription": "sample string 28",
      "OOSEndDate": "2024-05-01T18:52:08.3250252-04:00",
      "OOSStartDate": "2024-05-01T18:52:08.3250252-04:00",
      "Password": "sample string 29",
      "Port": 1,
      "PrimaryDevNum": 1,
      "PrimaryTransmitterCode": "sample string 30",
      "ProcessSignalsOnPrimaryFlag": true,
      "ProgramArgument": "sample string 31",
      "ProgramLabel": "sample string 32",
      "ProgramPath": "sample string 33",
      "SigForm": "sample string 34",
      "SignalFormatDescription": "sample string 35",
      "SignalForwardCode": "sample string 36",
      "SilentFlag": true,
      "SiteName": "sample string 37",
      "SiteNum": 1,
      "TimerTestAltHours": 1,
      "TimerTestAltMinutes": 1,
      "TimerTestDays": 1,
      "TimerTestDefaultInterval": "sample string 38",
      "TimerTestDescription": "sample string 39",
      "TimerTestHours": 1,
      "TimerTestMinutes": 1,
      "TimerTestNum": 1,
      "TitleSiteName": "sample string 40",
      "TransmitterCode": "sample string 41",
      "URLTarget": "sample string 42",
      "URLText": "sample string 43",
      "UserName": "sample string 44",
      "XmitOk": "sample string 45",
      "SiteType": "sample string 46",
      "SiteTypeDescription": "sample string 47",
      "Title": "sample string 48",
      "SiteGroupNum": 1
    },
    {
      "ActionPlanSearch": "sample string 1",
      "ActPlanDescription": "sample string 2",
      "AltDeviceID": "sample string 3",
      "AlternateTimerTestInterval": "sample string 4",
      "AlternateTimerTestWhenDisarmFlag": true,
      "ApplicationNum": 1,
      "BillingID": "sample string 5",
      "CommunicationType": "sample string 6",
      "CommunicationTypeDescription": "sample string 7",
      "CustomOption": "sample string 8",
      "DefaultFailTimerTestEvent": "sample string 9",
      "DefaultTimerTestDescription": "sample string 10",
      "DeviceConfigOnlyFlag": true,
      "DeviceInfo": "sample string 11",
      "DeviceIPAddress": "sample string 12",
      "DeviceLocation": "sample string 13",
      "DeviceType": "sample string 14",
      "DeviceTypeDescription": "sample string 15",
      "DevNum": 1,
      "EntryExitPeriod": "sample string 16",
      "EventCodeDescription": "sample string 17",
      "FailTTEventCode": "sample string 18",
      "FirstSignalDate": "2024-05-01T18:52:08.3250252-04:00",
      "FirstSignalTime": "sample string 19",
      "FunctionOption": "sample string 20",
      "HasDeviceFlag": true,
      "InServiceDate": "2024-05-01T18:52:08.3250252-04:00",
      "IntegrationPlatform": "sample string 21",
      "IntegrationPlatformDescription": "sample string 22",
      "IVRNum": "sample string 23",
      "LastSignalDate": "2024-05-01T18:52:08.3250252-04:00",
      "LineSecurity": "sample string 24",
      "ListenInDeviceType": "sample string 25",
      "ListenInDeviceTypeDescription": "sample string 26",
      "OOSCat": "sample string 27",
      "OOSCatDescription": "sample string 28",
      "OOSEndDate": "2024-05-01T18:52:08.3250252-04:00",
      "OOSStartDate": "2024-05-01T18:52:08.3250252-04:00",
      "Password": "sample string 29",
      "Port": 1,
      "PrimaryDevNum": 1,
      "PrimaryTransmitterCode": "sample string 30",
      "ProcessSignalsOnPrimaryFlag": true,
      "ProgramArgument": "sample string 31",
      "ProgramLabel": "sample string 32",
      "ProgramPath": "sample string 33",
      "SigForm": "sample string 34",
      "SignalFormatDescription": "sample string 35",
      "SignalForwardCode": "sample string 36",
      "SilentFlag": true,
      "SiteName": "sample string 37",
      "SiteNum": 1,
      "TimerTestAltHours": 1,
      "TimerTestAltMinutes": 1,
      "TimerTestDays": 1,
      "TimerTestDefaultInterval": "sample string 38",
      "TimerTestDescription": "sample string 39",
      "TimerTestHours": 1,
      "TimerTestMinutes": 1,
      "TimerTestNum": 1,
      "TitleSiteName": "sample string 40",
      "TransmitterCode": "sample string 41",
      "URLTarget": "sample string 42",
      "URLText": "sample string 43",
      "UserName": "sample string 44",
      "XmitOk": "sample string 45",
      "SiteType": "sample string 46",
      "SiteTypeDescription": "sample string 47",
      "Title": "sample string 48",
      "SiteGroupNum": 1
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<DeviceUpdateQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
  <ClientVersion>sample string 5</ClientVersion>
  <ErrorTypeNum>3</ErrorTypeNum>
  <SqlConnectionLost>true</SqlConnectionLost>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <DeviceUpdateResult>
      <ActPlanDescription>sample string 2</ActPlanDescription>
      <ActionPlanSearch>sample string 1</ActionPlanSearch>
      <AltDeviceID>sample string 3</AltDeviceID>
      <AlternateTimerTestInterval>sample string 4</AlternateTimerTestInterval>
      <AlternateTimerTestWhenDisarmFlag>true</AlternateTimerTestWhenDisarmFlag>
      <ApplicationNum>1</ApplicationNum>
      <BillingID>sample string 5</BillingID>
      <CommunicationType>sample string 6</CommunicationType>
      <CommunicationTypeDescription>sample string 7</CommunicationTypeDescription>
      <CustomOption>sample string 8</CustomOption>
      <DefaultFailTimerTestEvent>sample string 9</DefaultFailTimerTestEvent>
      <DefaultTimerTestDescription>sample string 10</DefaultTimerTestDescription>
      <DevNum>1</DevNum>
      <DeviceConfigOnlyFlag>true</DeviceConfigOnlyFlag>
      <DeviceIPAddress>sample string 12</DeviceIPAddress>
      <DeviceInfo>sample string 11</DeviceInfo>
      <DeviceLocation>sample string 13</DeviceLocation>
      <DeviceType>sample string 14</DeviceType>
      <DeviceTypeDescription>sample string 15</DeviceTypeDescription>
      <EntryExitPeriod>sample string 16</EntryExitPeriod>
      <EventCodeDescription>sample string 17</EventCodeDescription>
      <FailTTEventCode>sample string 18</FailTTEventCode>
      <FirstSignalDate>2024-05-01T18:52:08.3250252-04:00</FirstSignalDate>
      <FirstSignalTime>sample string 19</FirstSignalTime>
      <FunctionOption>sample string 20</FunctionOption>
      <HasDeviceFlag>true</HasDeviceFlag>
      <IVRNum>sample string 23</IVRNum>
      <InServiceDate>2024-05-01T18:52:08.3250252-04:00</InServiceDate>
      <IntegrationPlatform>sample string 21</IntegrationPlatform>
      <IntegrationPlatformDescription>sample string 22</IntegrationPlatformDescription>
      <LastSignalDate>2024-05-01T18:52:08.3250252-04:00</LastSignalDate>
      <LineSecurity>sample string 24</LineSecurity>
      <ListenInDeviceType>sample string 25</ListenInDeviceType>
      <ListenInDeviceTypeDescription>sample string 26</ListenInDeviceTypeDescription>
      <OOSCat>sample string 27</OOSCat>
      <OOSCatDescription>sample string 28</OOSCatDescription>
      <OOSEndDate>2024-05-01T18:52:08.3250252-04:00</OOSEndDate>
      <OOSStartDate>2024-05-01T18:52:08.3250252-04:00</OOSStartDate>
      <Password>sample string 29</Password>
      <Port>1</Port>
      <PrimaryDevNum>1</PrimaryDevNum>
      <PrimaryTransmitterCode>sample string 30</PrimaryTransmitterCode>
      <ProcessSignalsOnPrimaryFlag>true</ProcessSignalsOnPrimaryFlag>
      <ProgramArgument>sample string 31</ProgramArgument>
      <ProgramLabel>sample string 32</ProgramLabel>
      <ProgramPath>sample string 33</ProgramPath>
      <SigForm>sample string 34</SigForm>
      <SignalFormatDescription>sample string 35</SignalFormatDescription>
      <SignalForwardCode>sample string 36</SignalForwardCode>
      <SilentFlag>true</SilentFlag>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteName>sample string 37</SiteName>
      <SiteNum>1</SiteNum>
      <SiteType>sample string 46</SiteType>
      <SiteTypeDescription>sample string 47</SiteTypeDescription>
      <TimerTestAltHours>1</TimerTestAltHours>
      <TimerTestAltMinutes>1</TimerTestAltMinutes>
      <TimerTestDays>1</TimerTestDays>
      <TimerTestDefaultInterval>sample string 38</TimerTestDefaultInterval>
      <TimerTestDescription>sample string 39</TimerTestDescription>
      <TimerTestHours>1</TimerTestHours>
      <TimerTestMinutes>1</TimerTestMinutes>
      <TimerTestNum>1</TimerTestNum>
      <Title>sample string 48</Title>
      <TitleSiteName>sample string 40</TitleSiteName>
      <TransmitterCode>sample string 41</TransmitterCode>
      <URLTarget>sample string 42</URLTarget>
      <URLText>sample string 43</URLText>
      <UserName>sample string 44</UserName>
      <XmitOk>sample string 45</XmitOk>
    </DeviceUpdateResult>
    <DeviceUpdateResult>
      <ActPlanDescription>sample string 2</ActPlanDescription>
      <ActionPlanSearch>sample string 1</ActionPlanSearch>
      <AltDeviceID>sample string 3</AltDeviceID>
      <AlternateTimerTestInterval>sample string 4</AlternateTimerTestInterval>
      <AlternateTimerTestWhenDisarmFlag>true</AlternateTimerTestWhenDisarmFlag>
      <ApplicationNum>1</ApplicationNum>
      <BillingID>sample string 5</BillingID>
      <CommunicationType>sample string 6</CommunicationType>
      <CommunicationTypeDescription>sample string 7</CommunicationTypeDescription>
      <CustomOption>sample string 8</CustomOption>
      <DefaultFailTimerTestEvent>sample string 9</DefaultFailTimerTestEvent>
      <DefaultTimerTestDescription>sample string 10</DefaultTimerTestDescription>
      <DevNum>1</DevNum>
      <DeviceConfigOnlyFlag>true</DeviceConfigOnlyFlag>
      <DeviceIPAddress>sample string 12</DeviceIPAddress>
      <DeviceInfo>sample string 11</DeviceInfo>
      <DeviceLocation>sample string 13</DeviceLocation>
      <DeviceType>sample string 14</DeviceType>
      <DeviceTypeDescription>sample string 15</DeviceTypeDescription>
      <EntryExitPeriod>sample string 16</EntryExitPeriod>
      <EventCodeDescription>sample string 17</EventCodeDescription>
      <FailTTEventCode>sample string 18</FailTTEventCode>
      <FirstSignalDate>2024-05-01T18:52:08.3250252-04:00</FirstSignalDate>
      <FirstSignalTime>sample string 19</FirstSignalTime>
      <FunctionOption>sample string 20</FunctionOption>
      <HasDeviceFlag>true</HasDeviceFlag>
      <IVRNum>sample string 23</IVRNum>
      <InServiceDate>2024-05-01T18:52:08.3250252-04:00</InServiceDate>
      <IntegrationPlatform>sample string 21</IntegrationPlatform>
      <IntegrationPlatformDescription>sample string 22</IntegrationPlatformDescription>
      <LastSignalDate>2024-05-01T18:52:08.3250252-04:00</LastSignalDate>
      <LineSecurity>sample string 24</LineSecurity>
      <ListenInDeviceType>sample string 25</ListenInDeviceType>
      <ListenInDeviceTypeDescription>sample string 26</ListenInDeviceTypeDescription>
      <OOSCat>sample string 27</OOSCat>
      <OOSCatDescription>sample string 28</OOSCatDescription>
      <OOSEndDate>2024-05-01T18:52:08.3250252-04:00</OOSEndDate>
      <OOSStartDate>2024-05-01T18:52:08.3250252-04:00</OOSStartDate>
      <Password>sample string 29</Password>
      <Port>1</Port>
      <PrimaryDevNum>1</PrimaryDevNum>
      <PrimaryTransmitterCode>sample string 30</PrimaryTransmitterCode>
      <ProcessSignalsOnPrimaryFlag>true</ProcessSignalsOnPrimaryFlag>
      <ProgramArgument>sample string 31</ProgramArgument>
      <ProgramLabel>sample string 32</ProgramLabel>
      <ProgramPath>sample string 33</ProgramPath>
      <SigForm>sample string 34</SigForm>
      <SignalFormatDescription>sample string 35</SignalFormatDescription>
      <SignalForwardCode>sample string 36</SignalForwardCode>
      <SilentFlag>true</SilentFlag>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteName>sample string 37</SiteName>
      <SiteNum>1</SiteNum>
      <SiteType>sample string 46</SiteType>
      <SiteTypeDescription>sample string 47</SiteTypeDescription>
      <TimerTestAltHours>1</TimerTestAltHours>
      <TimerTestAltMinutes>1</TimerTestAltMinutes>
      <TimerTestDays>1</TimerTestDays>
      <TimerTestDefaultInterval>sample string 38</TimerTestDefaultInterval>
      <TimerTestDescription>sample string 39</TimerTestDescription>
      <TimerTestHours>1</TimerTestHours>
      <TimerTestMinutes>1</TimerTestMinutes>
      <TimerTestNum>1</TimerTestNum>
      <Title>sample string 48</Title>
      <TitleSiteName>sample string 40</TitleSiteName>
      <TransmitterCode>sample string 41</TransmitterCode>
      <URLTarget>sample string 42</URLTarget>
      <URLText>sample string 43</URLText>
      <UserName>sample string 44</UserName>
      <XmitOk>sample string 45</XmitOk>
    </DeviceUpdateResult>
  </ResultSet>
</DeviceUpdateQueryResult>