POST api/Site/XtNewXmitInsert
Request Information
URI Parameters
None.
Body Parameters
XtNewXtmitRequestName | Description | Type | Additional information |
---|---|---|---|
SiteGroupNum | integer |
None. |
|
CodeWord | string |
None. |
|
SiteName | string |
None. |
|
Region | string |
None. |
|
TimeZoneNum | integer |
None. |
|
SiteType | string |
None. |
|
InfoXml | RichText |
None. |
|
CrossStreet | string |
None. |
|
Directions | string |
None. |
|
Address | string |
None. |
|
Address2 | string |
None. |
|
City | string |
None. |
|
State | string |
None. |
|
ZipCode | string |
None. |
|
DeviceType | string |
None. |
|
TimerTestInterval | string |
None. |
|
FailTTEventCode | string |
None. |
|
OOSCat | string |
None. |
|
County | string |
None. |
|
LockBoxCode | string |
None. |
|
LockBoxLocation | string |
None. |
|
Township | string |
None. |
|
DataLocFlag | boolean |
None. |
|
AgenciesFlag | boolean |
None. |
|
PremisesPhone | string |
None. |
|
Contact1FirstName | string |
None. |
|
Contact1LastName | string |
None. |
|
Contact1Phone | string |
None. |
|
Contact1PhoneType | string |
None. |
|
Contact1PIN | string |
None. |
|
Contact2FirstName | string |
None. |
|
Contact2LastName | string |
None. |
|
Contact2Phone | string |
None. |
|
Contact2PhoneType | string |
None. |
|
Contact2PIN | string |
None. |
|
Prefix | string |
None. |
|
Permit | string |
None. |
|
CommunicationType | string |
None. |
|
BillingID | string |
None. |
|
SiteNum | integer |
None. |
|
DevNum | integer |
None. |
|
TransmitterCode | string |
None. |
|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "SiteGroupNum": 1, "CodeWord": "sample string 1", "SiteName": "sample string 2", "Region": "sample string 3", "TimeZoneNum": 1, "SiteType": "sample string 4", "InfoXml": { "SectionList": [ { "Value": "sample string 1", "BrFlag": true, "StyleList": [ { "Name": "sample string 1", "Value": "sample string 2" }, { "Name": "sample string 1", "Value": "sample string 2" } ] }, { "Value": "sample string 1", "BrFlag": true, "StyleList": [ { "Name": "sample string 1", "Value": "sample string 2" }, { "Name": "sample string 1", "Value": "sample string 2" } ] } ] }, "CrossStreet": "sample string 5", "Directions": "sample string 6", "Address": "sample string 7", "Address2": "sample string 8", "City": "sample string 9", "State": "sample string 10", "ZipCode": "sample string 11", "DeviceType": "sample string 12", "TimerTestInterval": "sample string 13", "FailTTEventCode": "sample string 14", "OOSCat": "sample string 15", "County": "sample string 16", "LockBoxCode": "sample string 17", "LockBoxLocation": "sample string 18", "Township": "sample string 19", "DataLocFlag": true, "AgenciesFlag": true, "PremisesPhone": "sample string 20", "Contact1FirstName": "sample string 21", "Contact1LastName": "sample string 22", "Contact1Phone": "sample string 23", "Contact1PhoneType": "sample string 24", "Contact1PIN": "sample string 25", "Contact2FirstName": "sample string 26", "Contact2LastName": "sample string 27", "Contact2Phone": "sample string 28", "Contact2PhoneType": "sample string 29", "Contact2PIN": "sample string 30", "Prefix": "sample string 31", "Permit": "sample string 32", "CommunicationType": "sample string 33", "BillingID": "sample string 34", "SiteNum": 1, "DevNum": 1, "TransmitterCode": "sample string 35", "SessionNum": 36, "SessionPassword": "QEA=", "ApplicationCode": "sample string 37", "StagesURL": "sample string 38" }
application/xml, text/xml
Sample:
<XtNewXtmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 38</StagesURL> <ApplicationCode>sample string 37</ApplicationCode> <SessionNum>36</SessionNum> <SessionPassword>QEA=</SessionPassword> <DevNum>1</DevNum> <SiteNum>1</SiteNum> <TransmitterCode>sample string 35</TransmitterCode> <Address>sample string 7</Address> <Address2>sample string 8</Address2> <AgenciesFlag>true</AgenciesFlag> <BillingID>sample string 34</BillingID> <City>sample string 9</City> <CodeWord>sample string 1</CodeWord> <CommunicationType>sample string 33</CommunicationType> <Contact1FirstName>sample string 21</Contact1FirstName> <Contact1LastName>sample string 22</Contact1LastName> <Contact1PIN>sample string 25</Contact1PIN> <Contact1Phone>sample string 23</Contact1Phone> <Contact1PhoneType>sample string 24</Contact1PhoneType> <Contact2FirstName>sample string 26</Contact2FirstName> <Contact2LastName>sample string 27</Contact2LastName> <Contact2PIN>sample string 30</Contact2PIN> <Contact2Phone>sample string 28</Contact2Phone> <Contact2PhoneType>sample string 29</Contact2PhoneType> <County>sample string 16</County> <CrossStreet>sample string 5</CrossStreet> <DataLocFlag>true</DataLocFlag> <DeviceType>sample string 12</DeviceType> <Directions>sample string 6</Directions> <FailTTEventCode>sample string 14</FailTTEventCode> <InfoXml xmlns:d2p1="http://schemas.datacontract.org/2004/07/Stages"> <d2p1:SectionList> <d2p1:Section> <d2p1:BrFlag>true</d2p1:BrFlag> <d2p1:StyleList> <d2p1:Style> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:Style> <d2p1:Style> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:Style> </d2p1:StyleList> <d2p1:Value>sample string 1</d2p1:Value> </d2p1:Section> <d2p1:Section> <d2p1:BrFlag>true</d2p1:BrFlag> <d2p1:StyleList> <d2p1:Style> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:Style> <d2p1:Style> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:Style> </d2p1:StyleList> <d2p1:Value>sample string 1</d2p1:Value> </d2p1:Section> </d2p1:SectionList> </InfoXml> <LockBoxCode>sample string 17</LockBoxCode> <LockBoxLocation>sample string 18</LockBoxLocation> <OOSCat>sample string 15</OOSCat> <Permit>sample string 32</Permit> <Prefix>sample string 31</Prefix> <PremisesPhone>sample string 20</PremisesPhone> <Region>sample string 3</Region> <SiteGroupNum>1</SiteGroupNum> <SiteName>sample string 2</SiteName> <SiteType>sample string 4</SiteType> <State>sample string 10</State> <TimeZoneNum>1</TimeZoneNum> <TimerTestInterval>sample string 13</TimerTestInterval> <Township>sample string 19</Township> <ZipCode>sample string 11</ZipCode> </XtNewXtmitRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
XtNewXmitInsertQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of XtNewXmitInsertResult |
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": [ { "Address": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "CodeWord": "sample string 4", "County": "sample string 5", "CrossStreet": "sample string 6", "DeviceType": "sample string 7", "DeviceTypeDescription": "sample string 8", "DevNum": 1, "Directions": "sample string 9", "EventCodeDescription": "sample string 10", "FailTTEventCode": "sample string 11", "FunctionOption": "sample string 12", "HasDeviceFlag": true, "InfoXml": { "SectionList": [ { "Value": "sample string 1", "BrFlag": true, "StyleList": [ { "Name": "sample string 1", "Value": "sample string 2" }, { "Name": "sample string 1", "Value": "sample string 2" } ] }, { "Value": "sample string 1", "BrFlag": true, "StyleList": [ { "Name": "sample string 1", "Value": "sample string 2" }, { "Name": "sample string 1", "Value": "sample string 2" } ] } ] }, "LockBoxCode": "sample string 13", "LockBoxLocation": "sample string 14", "OOSCat": "sample string 15", "OOSCatDescription": "sample string 16", "Region": "sample string 17", "RegionDescription": "sample string 18", "SiteGroupName": "sample string 19", "SiteGroupSearch": "sample string 20", "SiteName": "sample string 21", "SiteNum": 1, "SiteStatus": "sample string 22", "SiteStatusDescription": "sample string 23", "SiteType": "sample string 24", "SiteTypeDescription": "sample string 25", "State": "sample string 26", "TimerTestInterval": "sample string 27", "TimerTestIntervalDescription": "sample string 28", "TimeZoneDescription": "sample string 29", "TimeZoneNum": 1, "Title": "sample string 30", "Township": "sample string 31", "TransmitterCode": "sample string 32", "XmitOk": "sample string 33", "ZipCode": "sample string 34", "Permit": "sample string 35", "IntegrationPlatform": "sample string 36", "IntegrationPlatformDescription": "sample string 37", "ZipSelect": "sample string 38", "ZipSelectDescription": "sample string 39", "SiteGroupNum": 1 }, { "Address": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "CodeWord": "sample string 4", "County": "sample string 5", "CrossStreet": "sample string 6", "DeviceType": "sample string 7", "DeviceTypeDescription": "sample string 8", "DevNum": 1, "Directions": "sample string 9", "EventCodeDescription": "sample string 10", "FailTTEventCode": "sample string 11", "FunctionOption": "sample string 12", "HasDeviceFlag": true, "InfoXml": { "SectionList": [ { "Value": "sample string 1", "BrFlag": true, "StyleList": [ { "Name": "sample string 1", "Value": "sample string 2" }, { "Name": "sample string 1", "Value": "sample string 2" } ] }, { "Value": "sample string 1", "BrFlag": true, "StyleList": [ { "Name": "sample string 1", "Value": "sample string 2" }, { "Name": "sample string 1", "Value": "sample string 2" } ] } ] }, "LockBoxCode": "sample string 13", "LockBoxLocation": "sample string 14", "OOSCat": "sample string 15", "OOSCatDescription": "sample string 16", "Region": "sample string 17", "RegionDescription": "sample string 18", "SiteGroupName": "sample string 19", "SiteGroupSearch": "sample string 20", "SiteName": "sample string 21", "SiteNum": 1, "SiteStatus": "sample string 22", "SiteStatusDescription": "sample string 23", "SiteType": "sample string 24", "SiteTypeDescription": "sample string 25", "State": "sample string 26", "TimerTestInterval": "sample string 27", "TimerTestIntervalDescription": "sample string 28", "TimeZoneDescription": "sample string 29", "TimeZoneNum": 1, "Title": "sample string 30", "Township": "sample string 31", "TransmitterCode": "sample string 32", "XmitOk": "sample string 33", "ZipCode": "sample string 34", "Permit": "sample string 35", "IntegrationPlatform": "sample string 36", "IntegrationPlatformDescription": "sample string 37", "ZipSelect": "sample string 38", "ZipSelectDescription": "sample string 39", "SiteGroupNum": 1 } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<XtNewXmitInsertQueryResult 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> <XtNewXmitInsertResult> <Address>sample string 1</Address> <Address2>sample string 2</Address2> <City>sample string 3</City> <CodeWord>sample string 4</CodeWord> <County>sample string 5</County> <CrossStreet>sample string 6</CrossStreet> <DevNum>1</DevNum> <DeviceType>sample string 7</DeviceType> <DeviceTypeDescription>sample string 8</DeviceTypeDescription> <Directions>sample string 9</Directions> <EventCodeDescription>sample string 10</EventCodeDescription> <FailTTEventCode>sample string 11</FailTTEventCode> <FunctionOption>sample string 12</FunctionOption> <HasDeviceFlag>true</HasDeviceFlag> <InfoXml> <SectionList> <Section> <BrFlag>true</BrFlag> <StyleList> <Style> <Name>sample string 1</Name> <Value>sample string 2</Value> </Style> <Style> <Name>sample string 1</Name> <Value>sample string 2</Value> </Style> </StyleList> <Value>sample string 1</Value> </Section> <Section> <BrFlag>true</BrFlag> <StyleList> <Style> <Name>sample string 1</Name> <Value>sample string 2</Value> </Style> <Style> <Name>sample string 1</Name> <Value>sample string 2</Value> </Style> </StyleList> <Value>sample string 1</Value> </Section> </SectionList> </InfoXml> <IntegrationPlatform>sample string 36</IntegrationPlatform> <IntegrationPlatformDescription>sample string 37</IntegrationPlatformDescription> <LockBoxCode>sample string 13</LockBoxCode> <LockBoxLocation>sample string 14</LockBoxLocation> <OOSCat>sample string 15</OOSCat> <OOSCatDescription>sample string 16</OOSCatDescription> <Permit>sample string 35</Permit> <Region>sample string 17</Region> <RegionDescription>sample string 18</RegionDescription> <SiteGroupName>sample string 19</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSearch>sample string 20</SiteGroupSearch> <SiteName>sample string 21</SiteName> <SiteNum>1</SiteNum> <SiteStatus>sample string 22</SiteStatus> <SiteStatusDescription>sample string 23</SiteStatusDescription> <SiteType>sample string 24</SiteType> <SiteTypeDescription>sample string 25</SiteTypeDescription> <State>sample string 26</State> <TimeZoneDescription>sample string 29</TimeZoneDescription> <TimeZoneNum>1</TimeZoneNum> <TimerTestInterval>sample string 27</TimerTestInterval> <TimerTestIntervalDescription>sample string 28</TimerTestIntervalDescription> <Title>sample string 30</Title> <Township>sample string 31</Township> <TransmitterCode>sample string 32</TransmitterCode> <XmitOk>sample string 33</XmitOk> <ZipCode>sample string 34</ZipCode> <ZipSelect>sample string 38</ZipSelect> <ZipSelectDescription>sample string 39</ZipSelectDescription> </XtNewXmitInsertResult> <XtNewXmitInsertResult> <Address>sample string 1</Address> <Address2>sample string 2</Address2> <City>sample string 3</City> <CodeWord>sample string 4</CodeWord> <County>sample string 5</County> <CrossStreet>sample string 6</CrossStreet> <DevNum>1</DevNum> <DeviceType>sample string 7</DeviceType> <DeviceTypeDescription>sample string 8</DeviceTypeDescription> <Directions>sample string 9</Directions> <EventCodeDescription>sample string 10</EventCodeDescription> <FailTTEventCode>sample string 11</FailTTEventCode> <FunctionOption>sample string 12</FunctionOption> <HasDeviceFlag>true</HasDeviceFlag> <InfoXml> <SectionList> <Section> <BrFlag>true</BrFlag> <StyleList> <Style> <Name>sample string 1</Name> <Value>sample string 2</Value> </Style> <Style> <Name>sample string 1</Name> <Value>sample string 2</Value> </Style> </StyleList> <Value>sample string 1</Value> </Section> <Section> <BrFlag>true</BrFlag> <StyleList> <Style> <Name>sample string 1</Name> <Value>sample string 2</Value> </Style> <Style> <Name>sample string 1</Name> <Value>sample string 2</Value> </Style> </StyleList> <Value>sample string 1</Value> </Section> </SectionList> </InfoXml> <IntegrationPlatform>sample string 36</IntegrationPlatform> <IntegrationPlatformDescription>sample string 37</IntegrationPlatformDescription> <LockBoxCode>sample string 13</LockBoxCode> <LockBoxLocation>sample string 14</LockBoxLocation> <OOSCat>sample string 15</OOSCat> <OOSCatDescription>sample string 16</OOSCatDescription> <Permit>sample string 35</Permit> <Region>sample string 17</Region> <RegionDescription>sample string 18</RegionDescription> <SiteGroupName>sample string 19</SiteGroupName> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSearch>sample string 20</SiteGroupSearch> <SiteName>sample string 21</SiteName> <SiteNum>1</SiteNum> <SiteStatus>sample string 22</SiteStatus> <SiteStatusDescription>sample string 23</SiteStatusDescription> <SiteType>sample string 24</SiteType> <SiteTypeDescription>sample string 25</SiteTypeDescription> <State>sample string 26</State> <TimeZoneDescription>sample string 29</TimeZoneDescription> <TimeZoneNum>1</TimeZoneNum> <TimerTestInterval>sample string 27</TimerTestInterval> <TimerTestIntervalDescription>sample string 28</TimerTestIntervalDescription> <Title>sample string 30</Title> <Township>sample string 31</Township> <TransmitterCode>sample string 32</TransmitterCode> <XmitOk>sample string 33</XmitOk> <ZipCode>sample string 34</ZipCode> <ZipSelect>sample string 38</ZipSelect> <ZipSelectDescription>sample string 39</ZipSelectDescription> </XtNewXmitInsertResult> </ResultSet> </XtNewXmitInsertQueryResult>