GET v3/instances?startFrom={startFrom}&startTo={startTo}&interface={interface}&eventName={eventName}
Returns a list of specific instances
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| startFrom | date |
None. |
|
| startTo | date |
None. |
|
| attributes | Collection of NameValuePairOfString |
None. |
|
| interface | Interface |
Default value is All |
|
| eventAttributes | Collection of NameValuePairOfString |
None. |
|
| eventName | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of Instance| Name | Description | Type | Additional information |
|---|---|---|---|
| IsOnSale | boolean |
None. |
|
| PlanId | string |
None. |
|
| PriceList | PriceList |
None. |
|
| Event | Event |
None. |
|
| Start | date |
None. |
|
| StartUtc | date |
None. |
|
| StartSellingAtWeb | date |
None. |
|
| StartSellingAtWebUtc | date |
None. |
|
| StartSellingAtAgents | date |
None. |
|
| StartSellingAtAgentsUtc | date |
None. |
|
| StartSellingAtFundraising | date |
None. |
|
| StartSellingAtFundraisingUtc | date |
None. |
|
| StartSellingAtSales | date |
None. |
|
| StartSellingAtSalesUtc | date |
None. |
|
| StopSellingAtWeb | date |
None. |
|
| StopSellingAtWebUtc | date |
None. |
|
| StopSellingAtAgents | date |
None. |
|
| StopSellingAtAgentsUtc | date |
None. |
|
| StopSellingAtFundraising | date |
None. |
|
| StopSellingAtFundraisingUtc | date |
None. |
|
| StopSellingAtSales | date |
None. |
|
| StopSellingAtSalesUtc | date |
None. |
|
| WebInstanceId | string |
None. |
|
| Cancelled | boolean |
None. |
|
| Id | string |
None. |
|
| Attributes | There will be additional properties (custom to each client) with the prefix 'Attribute_' |
None. |
|
| HasBestAvailableOverlay | boolean |
None. |
Response Formats
application/json, text/xml
Sample:
Sample not available.