GET,POST,PUT,DELETE | /SpecialCollectionRequest |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ActiveOnly | body | bool | No | |
IncludeDeleted | body | bool | No | |
Name | body | string | No | |
Description | body | string | No | |
SqlQuery | body | string | No | |
FontIcon | body | string | No | |
TileImageUrl | body | string | No | |
TileTitle | body | string | No | |
SortOrder | body | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long? | No | |
OrderBy | form | string[] | No | |
OrderDirections | form | SortOrders[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Data | form | List<SpecialCollectionDto> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Total | form | int | No | |
OpCode | form | int | No | |
ErrorText | form | string | No | |
RequestTime | form | string | No | |
ResponseTime | form | string | No | |
TotalExecutionTime | form | string | No | |
CachedResponse | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Description | form | string | No | |
SqlQuery | form | string | No | |
FontIcon | form | string | No | |
TileImageUrl | form | string | No | |
TileTitle | form | string | No | |
SortOrder | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Active | form | bool | No | |
LastMod | form | DateTime | No | |
LastModBy | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Data | form | List<SpecialCollectionDto> | 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 /SpecialCollectionRequest HTTP/1.1
Host: cdnapidev.greysheet.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ActiveOnly":false,"IncludeDeleted":false,"Name":"String","Description":"String","SqlQuery":"String","FontIcon":"String","TileImageUrl":"String","TileTitle":"String","SortOrder":0,"Id":0,"OrderBy":["String"],"OrderDirections":["Asc"]}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Data":[{"Name":"String","Description":"String","SqlQuery":"String","FontIcon":"String","TileImageUrl":"String","TileTitle":"String","SortOrder":0,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}