Required roles: | Administrator, Administrator |
All Verbs | /service/db | ||
---|---|---|---|
All Verbs | /service/db/{Table} | ||
All Verbs | /service/db/{Table}/{Operation} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Table | path | string | No | |
Operation | path | DbOp | No | |
Payload | query | string | No | |
Fields | query | string | No | |
Skip | query | int? | No | |
Take | query | int? | No | |
OrderBy | query | string | No | |
OrderByDesc | query | string | No | |
Include | query | string | No | |
UsePayload | query | bool | No | |
Meta | query | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Inserted | form | long? | No | |
Updated | form | long? | No | |
Saved | form | long? | No | |
Deleted | form | long? | No | |
Operation | form | DbOp | No | |
Table | form | string | No | |
Payload | 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/db HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
table: String,
operation: ResolveKeys,
fields: String,
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
usePayload: False,
meta:
{
String: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { inserted: 0, updated: 0, saved: 0, deleted: 0, operation: Select, table: String, payload: String, offset: 0, total: 0, results: [ { } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }