Monitor Report Server

<back to all web services

ReportRequestApi

The following routes are available for this service:
GET,POST/reportapi
ReportRequestBase Parameters:
NameParameterData TypeRequiredDescription
ReportTypeformstringNo
StartTimeformDateTimeNo
EndTimeformDateTimeNo
CompanyIdformintNo
GroupTypeformReportGroupTypeNo
OptionsformList<ReportOptionsBase>No
ObjectsformList<ObjectOptions>No
TimeZoneIdformstringNo
SettingsformReportRequestSetting[]No
ApiRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
ReportOptionsBase Parameters:
NameParameterData TypeRequiredDescription
DebugformboolNo
ObjectOptions Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformintNo
ObjectNameformstringNo
ExternalObjectIdformstringNo
OptionsformList<IReportOptions>No
ArgumentsformObject[]No
IReportOptions Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ReportRequestSetting Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
ReportResult Parameters:
NameParameterData TypeRequiredDescription
ObjectsformList<ObjectReportSet>No
ObjectReportSet Parameters:
NameParameterData TypeRequiredDescription
ExternalObjectIdformstringNo
ObjectIdformintNo
ObjectNumberformstringNo
ReportsformList<ObjectReportItem>No
ObjectReportItem Parameters:
NameParameterData TypeRequiredDescription
RangeformDateTimeRangeNo
ReportformList<ReportBase>No
DateTimeRange Parameters:
NameParameterData TypeRequiredDescription
StartformDateTimeNo
EndformDateTimeNo
ReportBase Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformintNo
RangeformDateTimeRangeNo
RangeNameformstringNo
BuildTimeformTimeSpanNo
BuildTimeRangeformDateTimeRangeNo

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.

POST /reportapi HTTP/1.1 
Host: api.v3.monitorsystem.ru 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReportRequestApi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.WebApi.Client.Reporting">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/TS.WebApi.Client">String</ApiKey>
  <EndTime>0001-01-01T00:00:00</EndTime>
  <GroupType>None</GroupType>
  <Objects>
    <ObjectOptions>
      <Arguments xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
      </Arguments>
      <ExternalObjectId>String</ExternalObjectId>
      <ObjectName>String</ObjectName>
      <Options xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType i:nil="true" />
      </Options>
    </ObjectOptions>
  </Objects>
  <Options xmlns:d2p1="http://schemas.datacontract.org/2004/07/TS.Common.Reporting">
    <d2p1:ReportOptionsBase i:nil="true" />
  </Options>
  <ReportType>String</ReportType>
  <Settings>
    <ReportRequestSetting>
      <Name>String</Name>
      <Value>String</Value>
    </ReportRequestSetting>
  </Settings>
  <StartTime>0001-01-01T00:00:00</StartTime>
  <TimeZoneId>String</TimeZoneId>
</ReportRequestApi>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.Common.Reporting">
  <Objects>
    <ObjectReportSet>
      <ExternalObjectId>String</ExternalObjectId>
      <ObjectId>0</ObjectId>
      <ObjectNumber>String</ObjectNumber>
      <Reports>
        <ObjectReportItem>
          <Range>
            <End xmlns="">0001-01-01T00:00:00</End>
            <Start xmlns="">0001-01-01T00:00:00</Start>
          </Range>
          <Report>
            <ReportBase i:nil="true" />
          </Report>
        </ObjectReportItem>
      </Reports>
    </ObjectReportSet>
  </Objects>
</ReportResult>