POST api/PinManagement/GetAddressSuggestions

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Login	string	None.
Password	string	None.
UseTransactions	string	None.
JobToken	string	None.
Request	Request	None.

Request Formats

application/json, text/json

Sample:

{
  "Login": "sample string 1",
  "Password": "sample string 2",
  "UseTransactions": "sample string 3",
  "JobToken": "sample string 4",
  "Request": {
    "Parameters": {
      "Mode": "sample string 1",
      "CountrySets": [
        {
          "Result": {
            "MaxResultCount": 1
          },
          "OutputDetail": {
            "PreformattedData": {
              "PostalFormattedAddressLines": true,
              "SingleAddressLine": true,
              "SingleAddressLineDelimiter": "sample string 3"
            }
          },
          "Standardizations": [
            {
              "Default": {
                "PreferredLanguage": [
                  "sample string 1",
                  "sample string 2"
                ],
                "PreferredScript": {
                  "Script": "sample string 1",
                  "TransliterationType": "sample string 2",
                  "LimitLatinCharacters": "sample string 3"
                },
                "StandardizeInvalidAddresses": true,
                "FormatWithCountry": true,
                "CountryNameLanguage": "sample string 3",
                "CountryCodeType": "sample string 4",
                "MaxItemLength": 5,
                "Casing": "sample string 6",
                "DescriptorLength": "sample string 7",
                "AliasHandling": "sample string 8"
              }
            },
            {
              "Default": {
                "PreferredLanguage": [
                  "sample string 1",
                  "sample string 2"
                ],
                "PreferredScript": {
                  "Script": "sample string 1",
                  "TransliterationType": "sample string 2",
                  "LimitLatinCharacters": "sample string 3"
                },
                "StandardizeInvalidAddresses": true,
                "FormatWithCountry": true,
                "CountryNameLanguage": "sample string 3",
                "CountryCodeType": "sample string 4",
                "MaxItemLength": 5,
                "Casing": "sample string 6",
                "DescriptorLength": "sample string 7",
                "AliasHandling": "sample string 8"
              }
            }
          ]
        },
        {
          "Result": {
            "MaxResultCount": 1
          },
          "OutputDetail": {
            "PreformattedData": {
              "PostalFormattedAddressLines": true,
              "SingleAddressLine": true,
              "SingleAddressLineDelimiter": "sample string 3"
            }
          },
          "Standardizations": [
            {
              "Default": {
                "PreferredLanguage": [
                  "sample string 1",
                  "sample string 2"
                ],
                "PreferredScript": {
                  "Script": "sample string 1",
                  "TransliterationType": "sample string 2",
                  "LimitLatinCharacters": "sample string 3"
                },
                "StandardizeInvalidAddresses": true,
                "FormatWithCountry": true,
                "CountryNameLanguage": "sample string 3",
                "CountryCodeType": "sample string 4",
                "MaxItemLength": 5,
                "Casing": "sample string 6",
                "DescriptorLength": "sample string 7",
                "AliasHandling": "sample string 8"
              }
            },
            {
              "Default": {
                "PreferredLanguage": [
                  "sample string 1",
                  "sample string 2"
                ],
                "PreferredScript": {
                  "Script": "sample string 1",
                  "TransliterationType": "sample string 2",
                  "LimitLatinCharacters": "sample string 3"
                },
                "StandardizeInvalidAddresses": true,
                "FormatWithCountry": true,
                "CountryNameLanguage": "sample string 3",
                "CountryCodeType": "sample string 4",
                "MaxItemLength": 5,
                "Casing": "sample string 6",
                "DescriptorLength": "sample string 7",
                "AliasHandling": "sample string 8"
              }
            }
          ]
        }
      ]
    },
    "IO": {
      "Inputs": [
        {
          "OrganizationElements": {
            "Companies": [
              {
                "Value": "sample string 1"
              },
              {
                "Value": "sample string 1"
              }
            ]
          },
          "ContactElements": [
            {
              "Name": {
                "Value": "sample string 1"
              },
              "EMail": [
                {
                  "Value": "sample string 1"
                },
                {
                  "Value": "sample string 1"
                }
              ],
              "PhoneNumber": [
                {
                  "Value": "sample string 1"
                },
                {
                  "Value": "sample string 1"
                }
              ]
            },
            {
              "Name": {
                "Value": "sample string 1"
              },
              "EMail": [
                {
                  "Value": "sample string 1"
                },
                {
                  "Value": "sample string 1"
                }
              ],
              "PhoneNumber": [
                {
                  "Value": "sample string 1"
                },
                {
                  "Value": "sample string 1"
                }
              ]
            }
          ],
          "AddressElements": {
            "Locality": [
              {
                "Value": "sample string 1"
              },
              {
                "Value": "sample string 1"
              }
            ],
            "PostalCode": [
              {
                "Value": "sample string 1"
              },
              {
                "Value": "sample string 1"
              }
            ],
            "Country": "sample string 1"
          },
          "PreformattedData": {
            "PostalDeliveryAddressLines": [
              "sample string 1",
              "sample string 2"
            ],
            "SingleAddressLine": "sample string 1"
          }
        },
        {
          "OrganizationElements": {
            "Companies": [
              {
                "Value": "sample string 1"
              },
              {
                "Value": "sample string 1"
              }
            ]
          },
          "ContactElements": [
            {
              "Name": {
                "Value": "sample string 1"
              },
              "EMail": [
                {
                  "Value": "sample string 1"
                },
                {
                  "Value": "sample string 1"
                }
              ],
              "PhoneNumber": [
                {
                  "Value": "sample string 1"
                },
                {
                  "Value": "sample string 1"
                }
              ]
            },
            {
              "Name": {
                "Value": "sample string 1"
              },
              "EMail": [
                {
                  "Value": "sample string 1"
                },
                {
                  "Value": "sample string 1"
                }
              ],
              "PhoneNumber": [
                {
                  "Value": "sample string 1"
                },
                {
                  "Value": "sample string 1"
                }
              ]
            }
          ],
          "AddressElements": {
            "Locality": [
              {
                "Value": "sample string 1"
              },
              {
                "Value": "sample string 1"
              }
            ],
            "PostalCode": [
              {
                "Value": "sample string 1"
              },
              {
                "Value": "sample string 1"
              }
            ],
            "Country": "sample string 1"
          },
          "PreformattedData": {
            "PostalDeliveryAddressLines": [
              "sample string 1",
              "sample string 2"
            ],
            "SingleAddressLine": "sample string 1"
          }
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:

<AddressVerificationInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shell.ScolNextGen.API.Models.PinManagement.AddressVerificationInput">
  <JobToken>sample string 4</JobToken>
  <Login>sample string 1</Login>
  <Password>sample string 2</Password>
  <Request>
    <IO>
      <Inputs>
        <Input>
          <AddressElements>
            <Country>sample string 1</Country>
            <Locality>
              <Locality>
                <Value>sample string 1</Value>
              </Locality>
              <Locality>
                <Value>sample string 1</Value>
              </Locality>
            </Locality>
            <PostalCode>
              <PostalCode>
                <Value>sample string 1</Value>
              </PostalCode>
              <PostalCode>
                <Value>sample string 1</Value>
              </PostalCode>
            </PostalCode>
          </AddressElements>
          <ContactElements>
            <ContactElement>
              <EMail>
                <Email>
                  <Value>sample string 1</Value>
                </Email>
                <Email>
                  <Value>sample string 1</Value>
                </Email>
              </EMail>
              <Name>
                <Value>sample string 1</Value>
              </Name>
              <PhoneNumber>
                <PhoneNumber>
                  <Value>sample string 1</Value>
                </PhoneNumber>
                <PhoneNumber>
                  <Value>sample string 1</Value>
                </PhoneNumber>
              </PhoneNumber>
            </ContactElement>
            <ContactElement>
              <EMail>
                <Email>
                  <Value>sample string 1</Value>
                </Email>
                <Email>
                  <Value>sample string 1</Value>
                </Email>
              </EMail>
              <Name>
                <Value>sample string 1</Value>
              </Name>
              <PhoneNumber>
                <PhoneNumber>
                  <Value>sample string 1</Value>
                </PhoneNumber>
                <PhoneNumber>
                  <Value>sample string 1</Value>
                </PhoneNumber>
              </PhoneNumber>
            </ContactElement>
          </ContactElements>
          <OrganizationElements>
            <Companies>
              <Company>
                <Value>sample string 1</Value>
              </Company>
              <Company>
                <Value>sample string 1</Value>
              </Company>
            </Companies>
          </OrganizationElements>
          <PreformattedData>
            <PostalDeliveryAddressLines xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </PostalDeliveryAddressLines>
            <SingleAddressLine>sample string 1</SingleAddressLine>
          </PreformattedData>
        </Input>
        <Input>
          <AddressElements>
            <Country>sample string 1</Country>
            <Locality>
              <Locality>
                <Value>sample string 1</Value>
              </Locality>
              <Locality>
                <Value>sample string 1</Value>
              </Locality>
            </Locality>
            <PostalCode>
              <PostalCode>
                <Value>sample string 1</Value>
              </PostalCode>
              <PostalCode>
                <Value>sample string 1</Value>
              </PostalCode>
            </PostalCode>
          </AddressElements>
          <ContactElements>
            <ContactElement>
              <EMail>
                <Email>
                  <Value>sample string 1</Value>
                </Email>
                <Email>
                  <Value>sample string 1</Value>
                </Email>
              </EMail>
              <Name>
                <Value>sample string 1</Value>
              </Name>
              <PhoneNumber>
                <PhoneNumber>
                  <Value>sample string 1</Value>
                </PhoneNumber>
                <PhoneNumber>
                  <Value>sample string 1</Value>
                </PhoneNumber>
              </PhoneNumber>
            </ContactElement>
            <ContactElement>
              <EMail>
                <Email>
                  <Value>sample string 1</Value>
                </Email>
                <Email>
                  <Value>sample string 1</Value>
                </Email>
              </EMail>
              <Name>
                <Value>sample string 1</Value>
              </Name>
              <PhoneNumber>
                <PhoneNumber>
                  <Value>sample string 1</Value>
                </PhoneNumber>
                <PhoneNumber>
                  <Value>sample string 1</Value>
                </PhoneNumber>
              </PhoneNumber>
            </ContactElement>
          </ContactElements>
          <OrganizationElements>
            <Companies>
              <Company>
                <Value>sample string 1</Value>
              </Company>
              <Company>
                <Value>sample string 1</Value>
              </Company>
            </Companies>
          </OrganizationElements>
          <PreformattedData>
            <PostalDeliveryAddressLines xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </PostalDeliveryAddressLines>
            <SingleAddressLine>sample string 1</SingleAddressLine>
          </PreformattedData>
        </Input>
      </Inputs>
    </IO>
    <Parameters>
      <CountrySets>
        <CountrySet>
          <OutputDetail>
            <PreformattedData>
              <PostalFormattedAddressLines>true</PostalFormattedAddressLines>
              <SingleAddressLine>true</SingleAddressLine>
              <SingleAddressLineDelimiter>sample string 3</SingleAddressLineDelimiter>
            </PreformattedData>
          </OutputDetail>
          <Result>
            <MaxResultCount>1</MaxResultCount>
          </Result>
          <Standardizations>
            <Standardization>
              <Default>
                <AliasHandling>sample string 8</AliasHandling>
                <Casing>sample string 6</Casing>
                <CountryCodeType>sample string 4</CountryCodeType>
                <CountryNameLanguage>sample string 3</CountryNameLanguage>
                <DescriptorLength>sample string 7</DescriptorLength>
                <FormatWithCountry>true</FormatWithCountry>
                <MaxItemLength>5</MaxItemLength>
                <PreferredLanguage xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:string>sample string 1</d9p1:string>
                  <d9p1:string>sample string 2</d9p1:string>
                </PreferredLanguage>
                <PreferredScript>
                  <LimitLatinCharacters>sample string 3</LimitLatinCharacters>
                  <Script>sample string 1</Script>
                  <TransliterationType>sample string 2</TransliterationType>
                </PreferredScript>
                <StandardizeInvalidAddresses>true</StandardizeInvalidAddresses>
              </Default>
            </Standardization>
            <Standardization>
              <Default>
                <AliasHandling>sample string 8</AliasHandling>
                <Casing>sample string 6</Casing>
                <CountryCodeType>sample string 4</CountryCodeType>
                <CountryNameLanguage>sample string 3</CountryNameLanguage>
                <DescriptorLength>sample string 7</DescriptorLength>
                <FormatWithCountry>true</FormatWithCountry>
                <MaxItemLength>5</MaxItemLength>
                <PreferredLanguage xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:string>sample string 1</d9p1:string>
                  <d9p1:string>sample string 2</d9p1:string>
                </PreferredLanguage>
                <PreferredScript>
                  <LimitLatinCharacters>sample string 3</LimitLatinCharacters>
                  <Script>sample string 1</Script>
                  <TransliterationType>sample string 2</TransliterationType>
                </PreferredScript>
                <StandardizeInvalidAddresses>true</StandardizeInvalidAddresses>
              </Default>
            </Standardization>
          </Standardizations>
        </CountrySet>
        <CountrySet>
          <OutputDetail>
            <PreformattedData>
              <PostalFormattedAddressLines>true</PostalFormattedAddressLines>
              <SingleAddressLine>true</SingleAddressLine>
              <SingleAddressLineDelimiter>sample string 3</SingleAddressLineDelimiter>
            </PreformattedData>
          </OutputDetail>
          <Result>
            <MaxResultCount>1</MaxResultCount>
          </Result>
          <Standardizations>
            <Standardization>
              <Default>
                <AliasHandling>sample string 8</AliasHandling>
                <Casing>sample string 6</Casing>
                <CountryCodeType>sample string 4</CountryCodeType>
                <CountryNameLanguage>sample string 3</CountryNameLanguage>
                <DescriptorLength>sample string 7</DescriptorLength>
                <FormatWithCountry>true</FormatWithCountry>
                <MaxItemLength>5</MaxItemLength>
                <PreferredLanguage xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:string>sample string 1</d9p1:string>
                  <d9p1:string>sample string 2</d9p1:string>
                </PreferredLanguage>
                <PreferredScript>
                  <LimitLatinCharacters>sample string 3</LimitLatinCharacters>
                  <Script>sample string 1</Script>
                  <TransliterationType>sample string 2</TransliterationType>
                </PreferredScript>
                <StandardizeInvalidAddresses>true</StandardizeInvalidAddresses>
              </Default>
            </Standardization>
            <Standardization>
              <Default>
                <AliasHandling>sample string 8</AliasHandling>
                <Casing>sample string 6</Casing>
                <CountryCodeType>sample string 4</CountryCodeType>
                <CountryNameLanguage>sample string 3</CountryNameLanguage>
                <DescriptorLength>sample string 7</DescriptorLength>
                <FormatWithCountry>true</FormatWithCountry>
                <MaxItemLength>5</MaxItemLength>
                <PreferredLanguage xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:string>sample string 1</d9p1:string>
                  <d9p1:string>sample string 2</d9p1:string>
                </PreferredLanguage>
                <PreferredScript>
                  <LimitLatinCharacters>sample string 3</LimitLatinCharacters>
                  <Script>sample string 1</Script>
                  <TransliterationType>sample string 2</TransliterationType>
                </PreferredScript>
                <StandardizeInvalidAddresses>true</StandardizeInvalidAddresses>
              </Default>
            </Standardization>
          </Standardizations>
        </CountrySet>
      </CountrySets>
      <Mode>sample string 1</Mode>
    </Parameters>
  </Request>
  <UseTransactions>sample string 3</UseTransactions>
</AddressVerificationInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.