DocCloud API

<back to all web services

GetIndicatorQuery

Requires Authentication
The following routes are available for this service:
GET/indicator/{id}Get indicator by indicatorType Id
GetIndicatorQuery Parameters:
NameParameterData TypeRequiredDescription
IdpathuintNo
FromDatequeryDateTimeNo
ToDatequeryDateTimeNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
IndicatorDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
TypeformintNo
DataSetsformIList<Dataset>No
Dataset Parameters:
NameParameterData TypeRequiredDescription
ChartDisplayTypeformintNo
ChartTypeformintNo
TitleformstringNo
PointsformIList<DataPoint>No
DataPoint Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
ValueformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /indicator/{id} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetIndicatorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Indicator.Query">
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Indicator.Model" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.GlobalDto.Base">
    <d2p1:DataSets i:nil="true" />
    <d2p1:Title>String</d2p1:Title>
    <d2p1:Type>0</d2p1:Type>
  </Result>
</GetIndicatorResponse>