POST api/Address/SiteAddressDetail

Request Information

URI Parameters

None.

Body Parameters

SiteRequest
NameDescriptionTypeAdditional 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

SiteAddressDetailQueryResult
NameDescriptionTypeAdditional information
ExcludeColumnList

Collection of string

None.

ResultSet

Collection of SiteAddressDetailResult

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",
      "AddressDisplayURL": "sample string 4",
      "AddressURL": "sample string 5",
      "City": "sample string 6",
      "County": "sample string 7",
      "Description": "sample string 8",
      "Option": "sample string 9",
      "SiteName": "sample string 10",
      "SiteNum": 1,
      "State": "sample string 11",
      "Township": "sample string 12",
      "ZipCode": "sample string 13",
      "ZipSelect": "sample string 14",
      "ZipSelectDescription": "sample string 15",
      "Latitude": 1.0,
      "Longitude": 1.0,
      "AddressSearch": "sample string 16",
      "Country": "sample string 17",
      "StreetName": "sample string 18",
      "StreetNumber": "sample string 19"
    },
    {
      "Address": "sample string 1",
      "Address2": "sample string 2",
      "AddressDisplay": "sample string 3",
      "AddressDisplayURL": "sample string 4",
      "AddressURL": "sample string 5",
      "City": "sample string 6",
      "County": "sample string 7",
      "Description": "sample string 8",
      "Option": "sample string 9",
      "SiteName": "sample string 10",
      "SiteNum": 1,
      "State": "sample string 11",
      "Township": "sample string 12",
      "ZipCode": "sample string 13",
      "ZipSelect": "sample string 14",
      "ZipSelectDescription": "sample string 15",
      "Latitude": 1.0,
      "Longitude": 1.0,
      "AddressSearch": "sample string 16",
      "Country": "sample string 17",
      "StreetName": "sample string 18",
      "StreetNumber": "sample string 19"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:
<SiteAddressDetailQueryResult 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>
    <SiteAddressDetailResult>
      <Address>sample string 1</Address>
      <Address2>sample string 2</Address2>
      <AddressDisplay>sample string 3</AddressDisplay>
      <AddressDisplayURL>sample string 4</AddressDisplayURL>
      <AddressSearch>sample string 16</AddressSearch>
      <AddressURL>sample string 5</AddressURL>
      <City>sample string 6</City>
      <Country>sample string 17</Country>
      <County>sample string 7</County>
      <Description>sample string 8</Description>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <Option>sample string 9</Option>
      <SiteName>sample string 10</SiteName>
      <SiteNum>1</SiteNum>
      <State>sample string 11</State>
      <StreetName>sample string 18</StreetName>
      <StreetNumber>sample string 19</StreetNumber>
      <Township>sample string 12</Township>
      <ZipCode>sample string 13</ZipCode>
      <ZipSelect>sample string 14</ZipSelect>
      <ZipSelectDescription>sample string 15</ZipSelectDescription>
    </SiteAddressDetailResult>
    <SiteAddressDetailResult>
      <Address>sample string 1</Address>
      <Address2>sample string 2</Address2>
      <AddressDisplay>sample string 3</AddressDisplay>
      <AddressDisplayURL>sample string 4</AddressDisplayURL>
      <AddressSearch>sample string 16</AddressSearch>
      <AddressURL>sample string 5</AddressURL>
      <City>sample string 6</City>
      <Country>sample string 17</Country>
      <County>sample string 7</County>
      <Description>sample string 8</Description>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <Option>sample string 9</Option>
      <SiteName>sample string 10</SiteName>
      <SiteNum>1</SiteNum>
      <State>sample string 11</State>
      <StreetName>sample string 18</StreetName>
      <StreetNumber>sample string 19</StreetNumber>
      <Township>sample string 12</Township>
      <ZipCode>sample string 13</ZipCode>
      <ZipSelect>sample string 14</ZipSelect>
      <ZipSelectDescription>sample string 15</ZipSelectDescription>
    </SiteAddressDetailResult>
  </ResultSet>
</SiteAddressDetailQueryResult>