POST api/Address/MailAddressUpdateFull

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ChangeFlagAddressUsage	boolean	None.
ChangeFlagMailName	boolean	None.
ChangeFlagAddress	boolean	None.
ChangeFlagAddress2	boolean	None.
ChangeFlagStreetName	boolean	None.
ChangeFlagAddressInformation	boolean	None.
ChangeFlagZipSelect	boolean	None.
ChangeFlagCity	boolean	None.
ChangeFlagState	boolean	None.
ChangeFlagZipCode	boolean	None.
ChangeFlagCounty	boolean	None.
ChangeFlagTownship	boolean	None.
ChangeFlagBoundaryDistance	boolean	None.
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:

{
  "ChangeFlagAddressUsage": true,
  "ChangeFlagMailName": true,
  "ChangeFlagAddress": true,
  "ChangeFlagAddress2": true,
  "ChangeFlagStreetName": true,
  "ChangeFlagAddressInformation": true,
  "ChangeFlagZipSelect": true,
  "ChangeFlagCity": true,
  "ChangeFlagState": true,
  "ChangeFlagZipCode": true,
  "ChangeFlagCounty": true,
  "ChangeFlagTownship": true,
  "ChangeFlagBoundaryDistance": true,
  "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:

<MailAddressUpdateFullRequest 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>
  <ChangeFlagAddress>true</ChangeFlagAddress>
  <ChangeFlagAddress2>true</ChangeFlagAddress2>
  <ChangeFlagAddressInformation>true</ChangeFlagAddressInformation>
  <ChangeFlagAddressUsage>true</ChangeFlagAddressUsage>
  <ChangeFlagBoundaryDistance>true</ChangeFlagBoundaryDistance>
  <ChangeFlagCity>true</ChangeFlagCity>
  <ChangeFlagCounty>true</ChangeFlagCounty>
  <ChangeFlagMailName>true</ChangeFlagMailName>
  <ChangeFlagState>true</ChangeFlagState>
  <ChangeFlagStreetName>true</ChangeFlagStreetName>
  <ChangeFlagTownship>true</ChangeFlagTownship>
  <ChangeFlagZipCode>true</ChangeFlagZipCode>
  <ChangeFlagZipSelect>true</ChangeFlagZipSelect>
</MailAddressUpdateFullRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MailAddressUpdateQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of MailAddressUpdateResult	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",
      "County": "sample string 7",
      "KeyNum": 1,
      "KeyType": "sample string 8",
      "MailName": "sample string 9",
      "MessageString": "sample string 10",
      "Option": "sample string 11",
      "SeqNum": 1,
      "SiteName": "sample string 12",
      "State": "sample string 13",
      "StreetName": "sample string 14",
      "VerifiedFlag": true,
      "ZipCode": "sample string 15",
      "ZipSelect": "sample string 16",
      "ZipSelectDescription": "sample string 17",
      "BoundaryDistance": 1.0
    },
    {
      "Address": "sample string 1",
      "Address2": "sample string 2",
      "AddressInformation": "sample string 3",
      "AddressUsage": "sample string 4",
      "AddressUsageDescription": "sample string 5",
      "City": "sample string 6",
      "County": "sample string 7",
      "KeyNum": 1,
      "KeyType": "sample string 8",
      "MailName": "sample string 9",
      "MessageString": "sample string 10",
      "Option": "sample string 11",
      "SeqNum": 1,
      "SiteName": "sample string 12",
      "State": "sample string 13",
      "StreetName": "sample string 14",
      "VerifiedFlag": true,
      "ZipCode": "sample string 15",
      "ZipSelect": "sample string 16",
      "ZipSelectDescription": "sample string 17",
      "BoundaryDistance": 1.0
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<MailAddressUpdateQueryResult 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>
    <MailAddressUpdateResult>
      <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>
      <County>sample string 7</County>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 8</KeyType>
      <MailName>sample string 9</MailName>
      <MessageString>sample string 10</MessageString>
      <Option>sample string 11</Option>
      <SeqNum>1</SeqNum>
      <SiteName>sample string 12</SiteName>
      <State>sample string 13</State>
      <StreetName>sample string 14</StreetName>
      <VerifiedFlag>true</VerifiedFlag>
      <ZipCode>sample string 15</ZipCode>
      <ZipSelect>sample string 16</ZipSelect>
      <ZipSelectDescription>sample string 17</ZipSelectDescription>
    </MailAddressUpdateResult>
    <MailAddressUpdateResult>
      <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>
      <County>sample string 7</County>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 8</KeyType>
      <MailName>sample string 9</MailName>
      <MessageString>sample string 10</MessageString>
      <Option>sample string 11</Option>
      <SeqNum>1</SeqNum>
      <SiteName>sample string 12</SiteName>
      <State>sample string 13</State>
      <StreetName>sample string 14</StreetName>
      <VerifiedFlag>true</VerifiedFlag>
      <ZipCode>sample string 15</ZipCode>
      <ZipSelect>sample string 16</ZipSelect>
      <ZipSelectDescription>sample string 17</ZipSelectDescription>
    </MailAddressUpdateResult>
  </ResultSet>
</MailAddressUpdateQueryResult>