Home / API / ASP.NET Web API Details

GET api/v1/Account/GetSiteAddressByPhoneNumber?companyId={companyId}&phoneNumber={phoneNumber}

Description

Get Site Address Info by Phone Number

Request Information

Parameters

NameDescriptionAdditional information
companyId
Company Id

Define this parameter in the request URI.

phoneNumber
Phone Number - Digits Only

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "AddressId": 1,
    "AccountId": 2,
    "SiteId": 3,
    "BranchId": 4,
    "StreetNumber": "sample string 5",
    "PreDirection": "sample string 6",
    "StreetName": "sample string 7",
    "StreetSuffix": "sample string 8",
    "PostDirection": "sample string 9",
    "SecondaryAddress": "sample string 10",
    "City": "sample string 11",
    "State": "sample string 12",
    "PostalCode": "sample string 13",
    "PostalCodeEx": "sample string 14"
  },
  {
    "AddressId": 1,
    "AccountId": 2,
    "SiteId": 3,
    "BranchId": 4,
    "StreetNumber": "sample string 5",
    "PreDirection": "sample string 6",
    "StreetName": "sample string 7",
    "StreetSuffix": "sample string 8",
    "PostDirection": "sample string 9",
    "SecondaryAddress": "sample string 10",
    "City": "sample string 11",
    "State": "sample string 12",
    "PostalCode": "sample string 13",
    "PostalCodeEx": "sample string 14"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSiteAddressModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <SiteAddressModel>
    <AccountId>2</AccountId>
    <AddressId>1</AddressId>
    <BranchId>4</BranchId>
    <City>sample string 11</City>
    <PostDirection>sample string 9</PostDirection>
    <PostalCode>sample string 13</PostalCode>
    <PostalCodeEx>sample string 14</PostalCodeEx>
    <PreDirection>sample string 6</PreDirection>
    <SecondaryAddress>sample string 10</SecondaryAddress>
    <SiteId>3</SiteId>
    <State>sample string 12</State>
    <StreetName>sample string 7</StreetName>
    <StreetNumber>sample string 5</StreetNumber>
    <StreetSuffix>sample string 8</StreetSuffix>
  </SiteAddressModel>
  <SiteAddressModel>
    <AccountId>2</AccountId>
    <AddressId>1</AddressId>
    <BranchId>4</BranchId>
    <City>sample string 11</City>
    <PostDirection>sample string 9</PostDirection>
    <PostalCode>sample string 13</PostalCode>
    <PostalCodeEx>sample string 14</PostalCodeEx>
    <PreDirection>sample string 6</PreDirection>
    <SecondaryAddress>sample string 10</SecondaryAddress>
    <SiteId>3</SiteId>
    <State>sample string 12</State>
    <StreetName>sample string 7</StreetName>
    <StreetNumber>sample string 5</StreetNumber>
    <StreetSuffix>sample string 8</StreetSuffix>
  </SiteAddressModel>
</ArrayOfSiteAddressModel>