Home / API Documentation

Get Site Address Info by Phone Number

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

Response Format:

application/json

Required Parameters Description Additional information
companyId
Company Id

Define this parameter in the request URI.

phoneNumber
Phone Number - Digits Only

Define this parameter in the request URI.

application/json, text/json

Sample Response:
                        [
  {
    "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"
  }
];