All Verbs | /service/QueryMediaTags | ||
---|---|---|---|
All Verbs | /service/QueryMediaTags/{TagKind} | ||
All Verbs | /service/QueryMediaTagTotals | ||
All Verbs | /service/QueryMediaTagTotals/{TagKind} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TagKind | path | string | No | |
DoNotGroup | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | form | string | No | |
TagCriteria | form | Dictionary<string, HashSet<String>> | No | |
Context | form | string | No | |
Euid | form | Guid? | No | |
Id | form | int? | No | |
Active | form | bool? | 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 |
---|---|---|---|---|
PredecessorId | form | int? | No | |
ReplacePredecessor | form | bool | No | |
ContentType | form | string | No | |
Predecessor | form | Media | No | |
Realm | form | string | No | |
Height | form | double | No | |
Width | form | double | No | |
Area | form | double | No | |
ContentLength | form | double | No | |
ClientId | form | string | No | |
Url | form | string | No | |
OriginalUrl | form | string | No | |
Images | form | Dictionary<string, string> | No | |
Key | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RefId | form | string | No | |
Rating | form | double | No | |
Restricted | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Label | form | string | No | |
Name | form | string | No | |
Title | form | string | No | |
Active | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Euid | form | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | T | No | |
CreatedBy | form | string | No | |
CreatedOn | form | DateTime | No | |
LastModifiedOn | form | DateTime | No | |
LastModifiedBy | form | string | No | |
Position | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | string | No | |
Reason | form | string | No | |
InputId | form | string | No | |
InputIndex | form | int | No | |
CityStates | form | CityEntry[] | No | |
ZipCodes | form | ZipCodeEntry[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
City | form | string | No | |
MailableCity | form | bool | No | |
StateAbbreviation | form | string | No | |
State | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ZipCode | form | string | No | |
ZipCodeType | form | string | No | |
DefaultCity | form | string | No | |
CountyFips | form | string | No | |
CountyName | form | string | No | |
StateAbbreviation | form | string | No | |
State | form | string | No | |
Latitude | form | double | No | |
Longitude | form | double | No | |
Precision | form | string | No | |
AlternateCounties | form | AlternateCounty[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CountyFips | form | string | No | |
CountyName | form | string | No | |
StateAbbreviation | form | string | No | |
State | 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 .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/QueryMediaTags HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
tagKind: String,
doNotGroup: False,
search: String,
tagCriteria:
{
String:
[
String
]
},
context: String,
euid: 00000000-0000-0000-0000-000000000000,
id: 0,
active: False,
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: 0, tagLabel: String, position: 0, imageUrl: String, tags: { String: [ String ] } } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }