POST api/Address/SiteAddressDefault
Request Information
URI Parameters
None.
Body Parameters
SiteRequestName | Description | Type | Additional information |
---|---|---|---|
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:
{ "SiteNum": 1, "DevNum": 1, "TransmitterCode": "sample string 1", "SessionNum": 2, "SessionPassword": "QEA=", "ApplicationCode": "sample string 3", "StagesURL": "sample string 4" }
application/xml, text/xml
Sample:
<SiteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 4</StagesURL> <ApplicationCode>sample string 3</ApplicationCode> <SessionNum>2</SessionNum> <SessionPassword>QEA=</SessionPassword> <DevNum>1</DevNum> <SiteNum>1</SiteNum> <TransmitterCode>sample string 1</TransmitterCode> </SiteRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SiteAddressDefaultQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of SiteAddressDefaultResult |
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", "AddressDisplay": "sample string 3", "ASAPAddressVerifyDate": "2025-05-03T22:12:37.7053925-07:00", "City": "sample string 4", "Country": "sample string 5", "County": "sample string 6", "DataLocDate": "2025-05-03T22:12:37.7053925-07:00", "Latitude": 1.0, "Longitude": 1.0, "MessageString": "sample string 7", "Option": "sample string 8", "Result": "sample string 9", "SaveMsg": "sample string 10", "SiteName": "sample string 11", "SiteNum": 1, "SkipPsapFlag": "sample string 12", "State": "sample string 13", "StreetName": "sample string 14", "StreetNumber": "sample string 15", "StreetPostDirection": "sample string 16", "StreetPreDirection": "sample string 17", "StreetSuffix": "sample string 18", "Suite": "sample string 19", "Township": "sample string 20", "VerifiedFlag": true, "ZipCode": "sample string 21", "ZipSelect": "sample string 22", "ZipSelectDescription": "sample string 23", "CallingSource": "sample string 24", "AddressSearch": "sample string 25" }, { "Address": "sample string 1", "Address2": "sample string 2", "AddressDisplay": "sample string 3", "ASAPAddressVerifyDate": "2025-05-03T22:12:37.7053925-07:00", "City": "sample string 4", "Country": "sample string 5", "County": "sample string 6", "DataLocDate": "2025-05-03T22:12:37.7053925-07:00", "Latitude": 1.0, "Longitude": 1.0, "MessageString": "sample string 7", "Option": "sample string 8", "Result": "sample string 9", "SaveMsg": "sample string 10", "SiteName": "sample string 11", "SiteNum": 1, "SkipPsapFlag": "sample string 12", "State": "sample string 13", "StreetName": "sample string 14", "StreetNumber": "sample string 15", "StreetPostDirection": "sample string 16", "StreetPreDirection": "sample string 17", "StreetSuffix": "sample string 18", "Suite": "sample string 19", "Township": "sample string 20", "VerifiedFlag": true, "ZipCode": "sample string 21", "ZipSelect": "sample string 22", "ZipSelectDescription": "sample string 23", "CallingSource": "sample string 24", "AddressSearch": "sample string 25" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<SiteAddressDefaultQueryResult 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> <SiteAddressDefaultResult> <ASAPAddressVerifyDate>2025-05-03T22:12:37.7053925-07:00</ASAPAddressVerifyDate> <Address>sample string 1</Address> <Address2>sample string 2</Address2> <AddressDisplay>sample string 3</AddressDisplay> <AddressSearch>sample string 25</AddressSearch> <CallingSource>sample string 24</CallingSource> <City>sample string 4</City> <Country>sample string 5</Country> <County>sample string 6</County> <DataLocDate>2025-05-03T22:12:37.7053925-07:00</DataLocDate> <Latitude>1</Latitude> <Longitude>1</Longitude> <MessageString>sample string 7</MessageString> <Option>sample string 8</Option> <Result>sample string 9</Result> <SaveMsg>sample string 10</SaveMsg> <SiteName>sample string 11</SiteName> <SiteNum>1</SiteNum> <SkipPsapFlag>sample string 12</SkipPsapFlag> <State>sample string 13</State> <StreetName>sample string 14</StreetName> <StreetNumber>sample string 15</StreetNumber> <StreetPostDirection>sample string 16</StreetPostDirection> <StreetPreDirection>sample string 17</StreetPreDirection> <StreetSuffix>sample string 18</StreetSuffix> <Suite>sample string 19</Suite> <Township>sample string 20</Township> <VerifiedFlag>true</VerifiedFlag> <ZipCode>sample string 21</ZipCode> <ZipSelect>sample string 22</ZipSelect> <ZipSelectDescription>sample string 23</ZipSelectDescription> </SiteAddressDefaultResult> <SiteAddressDefaultResult> <ASAPAddressVerifyDate>2025-05-03T22:12:37.7053925-07:00</ASAPAddressVerifyDate> <Address>sample string 1</Address> <Address2>sample string 2</Address2> <AddressDisplay>sample string 3</AddressDisplay> <AddressSearch>sample string 25</AddressSearch> <CallingSource>sample string 24</CallingSource> <City>sample string 4</City> <Country>sample string 5</Country> <County>sample string 6</County> <DataLocDate>2025-05-03T22:12:37.7053925-07:00</DataLocDate> <Latitude>1</Latitude> <Longitude>1</Longitude> <MessageString>sample string 7</MessageString> <Option>sample string 8</Option> <Result>sample string 9</Result> <SaveMsg>sample string 10</SaveMsg> <SiteName>sample string 11</SiteName> <SiteNum>1</SiteNum> <SkipPsapFlag>sample string 12</SkipPsapFlag> <State>sample string 13</State> <StreetName>sample string 14</StreetName> <StreetNumber>sample string 15</StreetNumber> <StreetPostDirection>sample string 16</StreetPostDirection> <StreetPreDirection>sample string 17</StreetPreDirection> <StreetSuffix>sample string 18</StreetSuffix> <Suite>sample string 19</Suite> <Township>sample string 20</Township> <VerifiedFlag>true</VerifiedFlag> <ZipCode>sample string 21</ZipCode> <ZipSelect>sample string 22</ZipSelect> <ZipSelectDescription>sample string 23</ZipSelectDescription> </SiteAddressDefaultResult> </ResultSet> </SiteAddressDefaultQueryResult>