POST api/Address/MailAddressInsert

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
KeyNum	integer	None.
KeyType	string	None.
Address	string	None.
Address2	string	None.
AddressInformation	string	None.
AddressUsage	string	None.
City	string	None.
County	string	None.
State	string	None.
ZipCode	string	None.
SeqNum	integer	None.
MailName	string	None.
Township	string	None.
BoundaryDistance	decimal number	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "KeyNum": 1,
  "KeyType": "sample string 1",
  "Address": "sample string 2",
  "Address2": "sample string 3",
  "AddressInformation": "sample string 4",
  "AddressUsage": "sample string 5",
  "City": "sample string 6",
  "County": "sample string 7",
  "State": "sample string 8",
  "ZipCode": "sample string 9",
  "SeqNum": 1,
  "MailName": "sample string 10",
  "Township": "sample string 11",
  "BoundaryDistance": 1.0,
  "SessionNum": 12,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 13",
  "StagesURL": "sample string 14"
}

application/xml, text/xml

Sample:

<MailAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 14</StagesURL>
  <ApplicationCode>sample string 13</ApplicationCode>
  <SessionNum>12</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <Address>sample string 2</Address>
  <Address2>sample string 3</Address2>
  <AddressInformation>sample string 4</AddressInformation>
  <AddressUsage>sample string 5</AddressUsage>
  <BoundaryDistance>1</BoundaryDistance>
  <City>sample string 6</City>
  <County>sample string 7</County>
  <KeyNum>1</KeyNum>
  <KeyType>sample string 1</KeyType>
  <MailName>sample string 10</MailName>
  <SeqNum>1</SeqNum>
  <State>sample string 8</State>
  <Township>sample string 11</Township>
  <ZipCode>sample string 9</ZipCode>
</MailAddressRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MailAddressInsertQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of MailAddressInsertResult	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",
      "AddressInformation": "sample string 3",
      "AddressUsage": "sample string 4",
      "AddressUsageDescription": "sample string 5",
      "City": "sample string 6",
      "Country": "sample string 7",
      "County": "sample string 8",
      "HighlightFlag": true,
      "KeyNum": 1,
      "KeyType": "sample string 9",
      "Latitude": 1.0,
      "Longitude": 1.0,
      "MailName": "sample string 10",
      "SeqNum": 1,
      "SiteName": "sample string 11",
      "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",
      "ZipCode": "sample string 21",
      "BoundaryDistance": 1.0,
      "MessageString": "sample string 22",
      "Option": "sample string 23",
      "VerifiedFlag": true,
      "ZipSelect": "sample string 24",
      "ZipSelectDescription": "sample string 25"
    },
    {
      "Address": "sample string 1",
      "Address2": "sample string 2",
      "AddressInformation": "sample string 3",
      "AddressUsage": "sample string 4",
      "AddressUsageDescription": "sample string 5",
      "City": "sample string 6",
      "Country": "sample string 7",
      "County": "sample string 8",
      "HighlightFlag": true,
      "KeyNum": 1,
      "KeyType": "sample string 9",
      "Latitude": 1.0,
      "Longitude": 1.0,
      "MailName": "sample string 10",
      "SeqNum": 1,
      "SiteName": "sample string 11",
      "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",
      "ZipCode": "sample string 21",
      "BoundaryDistance": 1.0,
      "MessageString": "sample string 22",
      "Option": "sample string 23",
      "VerifiedFlag": true,
      "ZipSelect": "sample string 24",
      "ZipSelectDescription": "sample string 25"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<MailAddressInsertQueryResult 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>
    <MailAddressInsertResult>
      <Address>sample string 1</Address>
      <Address2>sample string 2</Address2>
      <AddressInformation>sample string 3</AddressInformation>
      <AddressUsage>sample string 4</AddressUsage>
      <AddressUsageDescription>sample string 5</AddressUsageDescription>
      <BoundaryDistance>1</BoundaryDistance>
      <City>sample string 6</City>
      <Country>sample string 7</Country>
      <County>sample string 8</County>
      <HighlightFlag>true</HighlightFlag>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 9</KeyType>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <MailName>sample string 10</MailName>
      <MessageString>sample string 22</MessageString>
      <Option>sample string 23</Option>
      <SeqNum>1</SeqNum>
      <SiteName>sample string 11</SiteName>
      <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 24</ZipSelect>
      <ZipSelectDescription>sample string 25</ZipSelectDescription>
    </MailAddressInsertResult>
    <MailAddressInsertResult>
      <Address>sample string 1</Address>
      <Address2>sample string 2</Address2>
      <AddressInformation>sample string 3</AddressInformation>
      <AddressUsage>sample string 4</AddressUsage>
      <AddressUsageDescription>sample string 5</AddressUsageDescription>
      <BoundaryDistance>1</BoundaryDistance>
      <City>sample string 6</City>
      <Country>sample string 7</Country>
      <County>sample string 8</County>
      <HighlightFlag>true</HighlightFlag>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 9</KeyType>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <MailName>sample string 10</MailName>
      <MessageString>sample string 22</MessageString>
      <Option>sample string 23</Option>
      <SeqNum>1</SeqNum>
      <SiteName>sample string 11</SiteName>
      <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 24</ZipSelect>
      <ZipSelectDescription>sample string 25</ZipSelectDescription>
    </MailAddressInsertResult>
  </ResultSet>
</MailAddressInsertQueryResult>