GET api/v1/reports/yearlyoverviewreport

Retrieves a Yearly Overview Report showing a summary of the monthly breakdown and month total

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.Integration.ReportMethods.YearlyOverviewResponse
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.Integration.ReportMethods.YearlyOverviewResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "YearlyInfo": {
        "ReportTitle": "sample string 1",
        "MonthList": [
          {
            "Date": "sample string 1",
            "records": [
              {
                "Status": "sample string 1",
                "Number": "sample string 2"
              },
              {
                "Status": "sample string 1",
                "Number": "sample string 2"
              }
            ]
          },
          {
            "Date": "sample string 1",
            "records": [
              {
                "Status": "sample string 1",
                "Number": "sample string 2"
              },
              {
                "Status": "sample string 1",
                "Number": "sample string 2"
              }
            ]
          }
        ]
      }
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfYearlyOverviewResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <YearlyInfo>
        <ReportTitle>sample string 1</ReportTitle>
        <MonthList>
          <MonthInfo>
            <Date>sample string 1</Date>
            <records>
              <StatusInfo>
                <Status>sample string 1</Status>
                <Number>sample string 2</Number>
              </StatusInfo>
              <StatusInfo>
                <Status>sample string 1</Status>
                <Number>sample string 2</Number>
              </StatusInfo>
            </records>
          </MonthInfo>
          <MonthInfo>
            <Date>sample string 1</Date>
            <records>
              <StatusInfo>
                <Status>sample string 1</Status>
                <Number>sample string 2</Number>
              </StatusInfo>
              <StatusInfo>
                <Status>sample string 1</Status>
                <Number>sample string 2</Number>
              </StatusInfo>
            </records>
          </MonthInfo>
        </MonthList>
      </YearlyInfo>
    </Detail>
  </ResponseData>
</ResponseOfYearlyOverviewResponse>