GET | /Common/DataExchangeInfo/{DocumentId} | ||
---|---|---|---|
GET | /Common/DataExchangeInfo |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentId | path | int? | No | |
ByUser | query | bool | No | |
NameContains | 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 |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
XType | form | int | No | |
UserName | form | string | No | |
UserId | form | int | No | |
CreateDate | form | DateTime | 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.
GET /Common/DataExchangeInfo/{DocumentId} HTTP/1.1 Host: apex.nikoratrade.ge Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Offset: 0, Total: 0, Results: [ { Id: 0, Name: String, XType: 0, UserName: String, UserId: 0, CreateDate: 0001-01-01 } ], Meta: { String: String }, ResponseStatus: { ErrorCode: String, Message: String, StackTrace: String, Errors: [ { ErrorCode: String, FieldName: String, Message: String, Meta: { String: String } } ], Meta: { String: String } } }