GET api/v1/widgets/gethotestzonesbypLacewdgt?placeCode={placeCode}&refresh={refresh}&number={number}&monthsBack={monthsBack}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
placeCode | string |
Required |
|
refresh | boolean |
Default value is False |
|
number | integer |
Default value is 5 |
|
monthsBack | integer |
Default value is 12 |
Body Parameters
None.
Response Information
Resource Description
SingleResultResponseOfWidgetWithDataDtoOfGetNumEchoesByZonesDtoName | Description | Type | Additional information |
---|---|---|---|
Meta | MetaSingleResult |
None. |
|
Notifications |
None. |
Response Formats
application/json, text/json
Sample:
{ "meta": {}, "notifications": [ {}, {} ], "result": { "id": "807cafa6-285f-4368-bc39-bbd1629e62db", "code": "sample string 2", "data": { "totalEchoes": 1, "numEchoesByZones": [ { "zoneName": "sample string 1", "zoneCode": "sample string 2", "num": 3 }, { "zoneName": "sample string 1", "zoneCode": "sample string 2", "num": 3 } ] } } }
application/xml, text/xml
Sample:
<SingleResultResponseOfWidgetWithDataDtoOfGetNumEchoesByZonesDto6G3gPdPvdOvjT49_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response"> <Meta /> <Notifications> <Notification /> <Notification /> </Notifications> <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Services.Dtos"> <d2p1:Code>sample string 2</d2p1:Code> <d2p1:Data xmlns:d3p1="http://schemas.datacontract.org/2004/07/Application.Services.Dtos.Location"> <d3p1:NumEchoesByZones> <d3p1:NumEchoesByZone> <d3p1:Num>3</d3p1:Num> <d3p1:ZoneCode>sample string 2</d3p1:ZoneCode> <d3p1:ZoneName>sample string 1</d3p1:ZoneName> </d3p1:NumEchoesByZone> <d3p1:NumEchoesByZone> <d3p1:Num>3</d3p1:Num> <d3p1:ZoneCode>sample string 2</d3p1:ZoneCode> <d3p1:ZoneName>sample string 1</d3p1:ZoneName> </d3p1:NumEchoesByZone> </d3p1:NumEchoesByZones> <d3p1:TotalEchoes>1</d3p1:TotalEchoes> </d2p1:Data> <d2p1:Id>807cafa6-285f-4368-bc39-bbd1629e62db</d2p1:Id> </Result> </SingleResultResponseOfWidgetWithDataDtoOfGetNumEchoesByZonesDto6G3gPdPvdOvjT49_P>