All Verbs | /service/QueryProspectsJoin |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No | |
Id | query | string | No | |
DateRange | query | string | No | |
Source | query | string | No | |
SalesRepId | query | string | No | |
Statuses | query | string | No | |
onlyHot | query | bool | No | |
TagCriteria | query | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
CompanyName | form | string | No | |
Name | form | string | No | |
Address | form | string | No | |
Address2 | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
Phone | form | string | No | |
Status | form | string | No | |
Source | form | string | No | |
Ranking | form | string | No | |
Notes | form | string | No | |
form | string | No | ||
Website | form | string | No | |
Title | form | string | No | |
Qualification | form | string | No | |
BestCallTime | form | string | No | |
CustomerId | form | string | No | |
VendorID | form | string | No | |
Vendor | form | Vendor | No | |
Meta | form | Dictionary<string, string> | No | |
CreatedOn | form | DateTime | No | |
ConvertedOn | form | DateTime? | No | |
SalesRepID | form | string | No | |
SalesRep | form | SalesRep | No | |
StoreTypes | form | HashSet<string> | No | |
StoreType | form | string | No | |
Hot | form | bool | No | |
IsModified | form | bool | No | |
IsUploaded | form | bool | No | |
AccountType | form | string | No | |
Category | form | string | No | |
OrderSource | form | string | No | |
Tags | form | Dictionary<string, HashSet<String>> | No | |
Customer | form | Retailer | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Label | form | string | No | |
VendorName | form | string | No | |
Abbreviation | form | string | No | |
OrderMinimum | form | decimal | No | |
ReOrderMinimum | form | decimal | No | |
MinimumBalance | form | decimal | No | |
Active | form | bool | No | |
IsInvoiceOnly | form | bool | No | |
AllowPriceOverride | form | bool | No | |
DefaultShipDatePrevious | form | bool | No | |
EnforceMinimums | form | bool | No | |
EnforcePurchaseIncrement | form | bool | No | |
AllowDiscounts | form | bool | No | |
EmailOrders | form | bool | No | |
AllowBackorders | form | bool | No | |
UseVendorCustId | form | bool | No | |
UseVendorShipId | form | bool | No | |
UseVendorTerms | form | bool | No | |
ExportReviewOrders | form | bool | No | |
EmailUrlToExport | form | bool | No | |
IncludeInBatch | form | bool | No | |
DecryptCCOnExport | form | bool | No | |
CustomerNumber | form | string | No | |
ExportOrders | form | bool | No | |
SplitByProductLine | form | bool | No | |
IsShowroomVendor | form | bool | No | |
AllowManualItemEntry | form | bool | No | |
RequireCreditSheet | form | bool | No | |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
form | string | No | ||
Website | form | string | No | |
Note | form | string | No | |
CommissionPercent | form | decimal | No | |
OrderTagLine | form | string | No | |
ProductTags | form | List<VendorProductTag> | No | |
Settings | form | List<VendorSetting> | No | |
LastLoginAttempt | form | DateTime | No | |
LastOrderedOn | form | DateTime | No | |
Meta | form | Dictionary<string, string> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Tag | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
VendorId | form | string | No | |
Key | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
FullName | form | string | No | |
UserName | form | string | No | |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
form | string | No | ||
Notes | form | string | No | |
RepGroupId | form | string | No | |
TerritoryId | form | string | No | |
RegionId | form | string | No | |
DivisionId | form | string | No | |
Bio | form | string | No | |
StartedOn | form | DateTime? | No | |
TerminatedOn | form | DateTime? | No | |
BornOn | form | DateTime? | No | |
Active | form | bool | No | |
TotalSales | form | double | No | |
Region | form | Region | No | |
Division | form | Division | No | |
Territory | form | Territory | No | |
LegacyUser | form | LegacyUser | No | |
User | form | EmunUserAuth | No | |
CustomerServiceEmailAddress | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
HouseAccount | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
RepGroup | form | string | No | |
KeyAccountGroup | form | string | No | |
IsKeyAccount | form | bool | No | |
SalesRepId | form | string | No | |
SalesRep | form | SalesRep | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
RegionId | form | string | No | |
Region | form | Region | No | |
ZipcodeCount | form | int | No | |
CustomerCount | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
UserName | form | string | No | |
FullName | form | string | No | |
ShortName | form | string | No | |
form | string | No | ||
Type | form | string | No | |
PriceList | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ContactId | form | string | No | |
RetailerId | form | string | No | |
SalesRepId | form | string | No | |
AspMembershipId | form | Guid | No | |
Meta | form | Dictionary<string, string> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Shard | form | string | No | |
form | string | No | ||
UserName | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
UserName | form | string | No | |
form | string | No | ||
PrimaryEmail | form | string | No | |
PhoneNumber | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
DisplayName | form | string | No | |
Company | form | string | No | |
BirthDate | form | DateTime? | No | |
BirthDateRaw | form | string | No | |
Address | form | string | No | |
Address2 | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Country | form | string | No | |
Culture | form | string | No | |
FullName | form | string | No | |
Gender | form | string | No | |
Language | form | string | No | |
MailAddress | form | string | No | |
Nickname | form | string | No | |
PostalCode | form | string | No | |
TimeZone | form | string | No | |
Salt | form | string | No | |
PasswordHash | form | string | No | |
DigestHa1Hash | form | string | No | |
Roles | form | List<string> | No | |
Permissions | form | List<string> | No | |
CreatedDate | form | DateTime | No | |
ModifiedDate | form | DateTime | No | |
InvalidLoginAttempts | form | int | No | |
LastLoginAttempt | form | DateTime? | No | |
LockedDate | form | DateTime? | No | |
RecoveryToken | form | string | No | |
RefId | form | int? | No | |
RefIdStr | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
OriginalId | form | string | No | |
CompanyName | form | string | No | |
Address | form | string | No | |
Address2 | form | string | No | |
Address3 | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
BillingLocation | form | AddressInfo | No | |
Phone | form | string | No | |
Fax | form | string | No | |
Contact | form | string | No | |
PaymentTerms | form | string | No | |
ShippingMethod | form | string | No | |
Notes | form | string | No | |
AccountType | form | string | No | |
Source | form | string | No | |
CustomerType | form | string | No | |
Status | form | string | No | |
IsKeyAccount | form | bool | No | |
DoNotUse | form | bool | No | |
IsNewAccount | form | bool | No | |
IsModified | form | bool | No | |
IsCreditHold | form | bool | No | |
IsSendSetupForm | form | bool | No | |
Residential | form | bool | No | |
form | string | No | ||
Website | form | string | No | |
FederalTaxID | form | string | No | |
StateTaxID | form | string | No | |
StateTaxExpiration | form | DateTime? | No | |
DefaultShipOn | form | DateTime? | No | |
ApiKey | form | string | No | |
PriceList | form | string | No | |
ContainerPriceList | form | string | No | |
Discount | form | double | No | |
Meta | form | Dictionary<string, string> | No | |
CreatedOn | form | DateTime | No | |
LastOrderedOn | form | DateTime | No | |
LastContactedOn | form | DateTime | No | |
LastLoginAttempt | form | DateTime | No | |
SalesReps | form | HashSet<string> | No | |
StoreTypes | form | HashSet<string> | No | |
PaymentTerm | form | PaymentTerm | No | |
SalesRep | form | SalesRep | No | |
ShipMethod | form | ShippingMethod | No | |
OpenOrders | form | int | No | |
OpenOrdersTotal | form | double | No | |
TotalSales | form | double | No | |
TotalSalesYTD | form | double | No | |
TotalSalesLY | form | double | No | |
TotalOrders | form | int | No | |
LastOrderTotal | form | decimal | No | |
LastOrderId | form | string | No | |
TerritoryId | form | string | No | |
RegionId | form | string | No | |
Region | form | Region | No | |
Territory | form | Territory | No | |
Keywords | form | string | No | |
Tags | form | Dictionary<string, HashSet<String>> | No | |
PORequired | form | bool | No | |
Balance | form | double | No | |
TotalBalance | form | double | No | |
FutureBalance | form | double | No | |
Past1Days | form | double | No | |
Past30Days | form | double | No | |
Past60Days | form | double | No | |
Past90Days | form | double | No | |
ERPCustId | form | string | No | |
RestrictionGroup | form | string | No | |
CreditLimit | form | double | No | |
CreditAvailable | form | double | No | |
LocationType | form | string | No | |
Reference1 | form | string | No | |
TotalShipTos | form | int | No | |
ThisYearInvoiced | form | double | No | |
LastYearInvoiced | form | double | No | |
TotalOpenOrders | form | double | No | |
ValidateAddress | form | bool | No | |
Hash | form | string | No | |
SetupCompleted | form | bool | No | |
InfoReviewed | form | bool | No | |
Ranking | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
CompanyName | form | string | No | |
PersonName | form | PersonNameInfo | No | |
Address | form | string | No | |
Address1 | form | string | No | |
Address2 | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
form | string | No | ||
StoreSize | form | string | No | |
Custom2 | form | string | No | |
AccountType | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Salutation | form | string | No | |
First | form | string | No | |
Middle | form | string | No | |
Last | form | string | No | |
Suffix | form | string | No | |
Full | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
IsCredit | form | bool | No | |
IsStandard | form | bool | No | |
IsB2B | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryProspectsJoin HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"search":"String","id":"String","dateRange":"String","source":"String","salesRepId":"String","statuses":"String","onlyHot":false,"tagCriteria":{"String":["String"]},"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"offset":0,"total":0,"results":[{"id":"String","companyName":"String","status":"String","salesRepID":"String","salesRepName":"String","regionName":"String","label":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}