GET api/rep/PublicInfo/GetByAddress?postalCode={postalCode}&city={city}&state={state}&country={country}&plugging={plugging}&exactZip={exactZip}
Find Reps based on address information
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| postalCode | string |
Default value is |
|
| city | string |
Default value is |
|
| state | string |
Default value is |
|
| country | string |
Default value is |
|
| plugging | boolean |
Default value is False |
|
| exactZip | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of PublicRepInfoViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| RepDID |
The representative's Display ID |
string |
None. |
| DisplayName |
The display name shown for the rep. |
string |
None. |
| DisplayNameHeader | string |
None. |
|
| Company |
The representative's company name |
string |
None. |
| FirstName |
The representative's first name |
string |
None. |
| LastName |
The representative's last name |
string |
None. |
| PublicImageUrl |
The representative's publicly available image url. |
string |
None. |
| ShouldAskToSwitch |
Whether the cart should ask to switch order association |
boolean |
None. |
| ReplicatedSiteUrl |
The representative's url |
string |
None. |
| City |
The representative's city |
string |
None. |
| State |
The representative's state |
string |
None. |
| Country |
The representative's Country |
string |
None. |
| Phone | string |
None. |
|
| string |
None. |
||
| RepSocialNetworks | Collection of IRepSocialNetworkPublicInfoViewModel |
None. |
Response Formats
application/xml, text/xml
Sample:
<ListOfPublicRepInfoViewModel>
<PublicRepInfoViewModel>
<RepDID>sample string 1</RepDID>
<DisplayName>sample string 2</DisplayName>
<DisplayNameHeader>sample string 3</DisplayNameHeader>
<Company>sample string 4</Company>
<FirstName>sample string 5</FirstName>
<LastName>sample string 6</LastName>
<PublicImageUrl>sample string 7</PublicImageUrl>
<ShouldAskToSwitch>True</ShouldAskToSwitch>
<ReplicatedSiteUrl>sample string 9</ReplicatedSiteUrl>
<City>sample string 10</City>
<State>sample string 11</State>
<Country>sample string 12</Country>
<Phone>sample string 13</Phone>
<Email>sample string 14</Email>
<RepSocialNetworks />
</PublicRepInfoViewModel>
<PublicRepInfoViewModel>
<RepDID>sample string 1</RepDID>
<DisplayName>sample string 2</DisplayName>
<DisplayNameHeader>sample string 3</DisplayNameHeader>
<Company>sample string 4</Company>
<FirstName>sample string 5</FirstName>
<LastName>sample string 6</LastName>
<PublicImageUrl>sample string 7</PublicImageUrl>
<ShouldAskToSwitch>True</ShouldAskToSwitch>
<ReplicatedSiteUrl>sample string 9</ReplicatedSiteUrl>
<City>sample string 10</City>
<State>sample string 11</State>
<Country>sample string 12</Country>
<Phone>sample string 13</Phone>
<Email>sample string 14</Email>
<RepSocialNetworks />
</PublicRepInfoViewModel>
</ListOfPublicRepInfoViewModel>
application/json, text/json
Sample:
[
{
"RepDID": "sample string 1",
"DisplayName": "sample string 2",
"DisplayNameHeader": "sample string 3",
"Company": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"PublicImageUrl": "sample string 7",
"ShouldAskToSwitch": true,
"ReplicatedSiteUrl": "sample string 9",
"City": "sample string 10",
"State": "sample string 11",
"Country": "sample string 12",
"Phone": "sample string 13",
"Email": "sample string 14"
},
{
"RepDID": "sample string 1",
"DisplayName": "sample string 2",
"DisplayNameHeader": "sample string 3",
"Company": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"PublicImageUrl": "sample string 7",
"ShouldAskToSwitch": true,
"ReplicatedSiteUrl": "sample string 9",
"City": "sample string 10",
"State": "sample string 11",
"Country": "sample string 12",
"Phone": "sample string 13",
"Email": "sample string 14"
}
]