POST api/MonthlyReport

Request Information

URI Parameters

None.

Body Parameters

RequestMonthly
NameDescriptionTypeAdditional information
year

string

None.

startMonth

string

None.

endMonth

string

None.

header_id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "year": "sample string 1",
  "startMonth": "sample string 2",
  "endMonth": "sample string 3",
  "header_id": 4
}

application/xml, text/xml

Sample:
<MonthlyReportController.RequestMonthly xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APISMS.Controllers.Report">
  <endMonth>sample string 3</endMonth>
  <header_id>4</header_id>
  <startMonth>sample string 2</startMonth>
  <year>sample string 1</year>
</MonthlyReportController.RequestMonthly>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultMonthlyReport
NameDescriptionTypeAdditional information
ResultCode

string

None.

ResultDesc

string

None.

Monthly

Collection of BulkSMSLog

None.

Response Formats

application/json, text/json

Sample:
{
  "ResultCode": "sample string 1",
  "ResultDesc": "sample string 2",
  "Monthly": [
    {
      "subs": 1,
      "year": 2,
      "month": 3,
      "sms_count": 4
    },
    {
      "subs": 1,
      "year": 2,
      "month": 3,
      "sms_count": 4
    }
  ]
}

application/xml, text/xml

Sample:
<MonthlyReportController.ResultMonthlyReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APISMS.Controllers.Report">
  <Monthly>
    <MonthlyReportController.BulkSMSLog>
      <month>3</month>
      <sms_count>4</sms_count>
      <subs>1</subs>
      <year>2</year>
    </MonthlyReportController.BulkSMSLog>
    <MonthlyReportController.BulkSMSLog>
      <month>3</month>
      <sms_count>4</sms_count>
      <subs>1</subs>
      <year>2</year>
    </MonthlyReportController.BulkSMSLog>
  </Monthly>
  <ResultCode>sample string 1</ResultCode>
  <ResultDesc>sample string 2</ResultDesc>
</MonthlyReportController.ResultMonthlyReport>