GET API/Advertisement/GetAdvertisements?aSponsorID={aSponsorID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| aSponsorID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
AdvertisementResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Advertisements | Collection of Advertisement |
None. |
|
| SponsorID | integer |
None. |
|
| Logo | Advertisement |
None. |
|
| Success | boolean |
None. |
|
| ErrorCode | ErrorCodes |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Advertisements": [
{
"ID": 1,
"ImageURL": "sample string 2",
"DestinationURL": "sample string 3",
"BackgroundColor": "sample string 4",
"Sequence": 5,
"IsNotification": true,
"DisplayID": 7
},
{
"ID": 1,
"ImageURL": "sample string 2",
"DestinationURL": "sample string 3",
"BackgroundColor": "sample string 4",
"Sequence": 5,
"IsNotification": true,
"DisplayID": 7
}
],
"SponsorID": 1,
"Logo": {
"ID": 1,
"ImageURL": "sample string 2",
"DestinationURL": "sample string 3",
"BackgroundColor": "sample string 4",
"Sequence": 5,
"IsNotification": true,
"DisplayID": 7
},
"Success": true,
"ErrorCode": 101,
"Message": "sample string 3"
}
application/xml, text/xml
Sample:
<AdvertisementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Budget_WebAPI.Models">
<ErrorCode>InvalidToken</ErrorCode>
<Message>sample string 3</Message>
<Success>true</Success>
<Logo>
<BackgroundColor>sample string 4</BackgroundColor>
<DestinationURL>sample string 3</DestinationURL>
<DisplayID>7</DisplayID>
<ID>1</ID>
<ImageURL>sample string 2</ImageURL>
<IsNotification>true</IsNotification>
<Sequence>5</Sequence>
</Logo>
<SponsorID>1</SponsorID>
<Advertisements>
<Advertisement>
<BackgroundColor>sample string 4</BackgroundColor>
<DestinationURL>sample string 3</DestinationURL>
<DisplayID>7</DisplayID>
<ID>1</ID>
<ImageURL>sample string 2</ImageURL>
<IsNotification>true</IsNotification>
<Sequence>5</Sequence>
</Advertisement>
<Advertisement>
<BackgroundColor>sample string 4</BackgroundColor>
<DestinationURL>sample string 3</DestinationURL>
<DisplayID>7</DisplayID>
<ID>1</ID>
<ImageURL>sample string 2</ImageURL>
<IsNotification>true</IsNotification>
<Sequence>5</Sequence>
</Advertisement>
</Advertisements>
</AdvertisementResponse>