GET api/v1/reports/yearlycreditusage?softwareVersion={softwareVersion}

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

Request Information

URI Parameters

Name	Description	Type	Additional information
softwareVersion	Information on what application is accessing the api	string	None.

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.Integration.ReportMethods.YearlyCreditUsageResponse

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.Integration.ReportMethods.YearlyCreditUsageResponse	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": {
      "YearlyCreditInfo": {
        "ReportTitle": "sample string 1",
        "MonthList": [
          {
            "Date": "sample string 1",
            "records": [
              {
                "OffPeak": "sample string 1",
                "Anytime": "sample string 2"
              },
              {
                "OffPeak": "sample string 1",
                "Anytime": "sample string 2"
              }
            ]
          },
          {
            "Date": "sample string 1",
            "records": [
              {
                "OffPeak": "sample string 1",
                "Anytime": "sample string 2"
              },
              {
                "OffPeak": "sample string 1",
                "Anytime": "sample string 2"
              }
            ]
          }
        ]
      }
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfYearlyCreditUsageResponse 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>
      <YearlyCreditInfo>
        <ReportTitle>sample string 1</ReportTitle>
        <MonthList>
          <MonthInforamtion>
            <Date>sample string 1</Date>
            <records>
              <CreditInfo>
                <OffPeak>sample string 1</OffPeak>
                <Anytime>sample string 2</Anytime>
              </CreditInfo>
              <CreditInfo>
                <OffPeak>sample string 1</OffPeak>
                <Anytime>sample string 2</Anytime>
              </CreditInfo>
            </records>
          </MonthInforamtion>
          <MonthInforamtion>
            <Date>sample string 1</Date>
            <records>
              <CreditInfo>
                <OffPeak>sample string 1</OffPeak>
                <Anytime>sample string 2</Anytime>
              </CreditInfo>
              <CreditInfo>
                <OffPeak>sample string 1</OffPeak>
                <Anytime>sample string 2</Anytime>
              </CreditInfo>
            </records>
          </MonthInforamtion>
        </MonthList>
      </YearlyCreditInfo>
    </Detail>
  </ResponseData>
</ResponseOfYearlyCreditUsageResponse>