All Verbs | /service/QueryRetailerContactsJoin |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RetailerId | query | string | No | |
Search | query | string | No | |
RegistrationEmail | query | string | No | |
IncludeAllContacts | query | bool | No | |
OnlyWithEmail | 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 | |
RetailerId | form | string | No | |
Name | form | string | No | |
form | string | No | ||
Phone | form | string | No | |
SecondaryEmail | form | string | No | |
Extension | form | string | No | |
MobilePhone | form | string | No | |
Fax | form | string | No | |
Title | form | string | No | |
IsPrimary | form | bool | No | |
IsNonEditable | form | bool | No | |
CreatedOn | form | DateTime? | No | |
New | form | bool | No | |
Active | form | bool | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryRetailerContactsJoin HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
retailerId: String,
search: String,
registrationEmail: String,
includeAllContacts: False,
onlyWithEmail: 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/jsv Content-Length: length { offset: 0, total: 0, results: [ { id: String, name: String, email: String, phone: String, mobilePhone: String, zip: String, fax: String, title: String, isPrimary: False, isNonEditable: False, createdOn: 0001-01-01, new: False, retailerCompanyName: String } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }