All Verbs | /service/QueryCompletedForms |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TagCriteria | query | Dictionary<string, HashSet<String>> | No | |
RetailerId | query | string | No | |
VendorId | query | string | No | |
Search | query | 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 |
---|---|---|---|---|
Data | form | JsonObject | No | |
Events | form | JsonObject | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
RefId | form | string | No | |
Euid | form | Guid | No | |
Label | form | string | No | |
Description | form | string | No | |
Active | form | bool | No | |
Tags | form | Dictionary<string, HashSet<String>> | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CreatedBy | form | string | No | |
CreatedOn | form | DateTime | No | |
LastModifiedOn | form | DateTime | No | |
LastModifiedBy | form | string | No | |
Generated | form | bool | No | |
Exported | form | bool | No | |
Position | form | int | 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/QueryCompletedForms HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"tagCriteria":{"String":["String"]},"retailerId":"String","vendorId":"String","search":"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","label":"String","createdOn":"0001-01-01T00:00:00.0000000Z","companyName":"String","meta":{"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"}}}