| GET | /WebAdRequest |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ImageUrl | query | string | No | |
| ScreenName | query | string | No | |
| Title | query | string | No | |
| BodyText | query | string | No | |
| DestinationUrl | query | string | No | |
| Device | query | string | No | |
| Locations | query | string | No | |
| StartDate | query | string | No | |
| EndDate | query | string | No | |
| SortOrder | query | int | No | |
| DisplayCount | query | int | No | |
| ClickCount | query | int | No | |
| CustomerId | query | long | No | |
| ActiveOnly | query | bool | 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<WebAdDto> | 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 |
|---|---|---|---|---|
| ImageUrl | form | string | No | |
| ScreenName | form | string | No | |
| Title | form | string | No | |
| BodyText | form | string | No | |
| DestinationUrl | form | string | No | |
| Device | form | string | No | |
| Locations | form | string | No | |
| StartDate | form | DateTime | No | |
| StartDateStr | form | string | No | |
| StartDay | form | int | No | |
| StartMonth | form | int | No | |
| StartYear | form | int | No | |
| EndDate | form | DateTime | No | |
| EndDateStr | form | string | No | |
| EndDay | form | int | No | |
| EndMonth | form | int | No | |
| EndYear | form | int | No | |
| SortOrder | form | int | No | |
| DisplayCount | form | int | No | |
| ClickCount | form | int | No | |
| CustomerId | form | long | No | |
| CustomerName | form | string | 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<WebAdDto> | 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 /WebAdRequest HTTP/1.1 Host: mobileapidevsw.greysheet.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Data:
[
{
ImageUrl: String,
ScreenName: String,
Title: String,
BodyText: String,
DestinationUrl: String,
Device: String,
Locations: String,
StartDate: 0001-01-01,
StartDateStr: String,
StartDay: 0,
StartMonth: 0,
StartYear: 0,
EndDate: 0001-01-01,
EndDateStr: String,
EndDay: 0,
EndMonth: 0,
EndYear: 0,
SortOrder: 0,
DisplayCount: 0,
ClickCount: 0,
CustomerId: 0,
CustomerName: String,
Id: 0,
Active: False,
LastMod: 0001-01-01,
LastModBy: String
}
],
Total: 0,
OpCode: 0,
ErrorText: String,
RequestTime: String,
ResponseTime: String,
TotalExecutionTime: String,
CachedResponse: False
}