GET api/v1/reports/subAccountOverview

Returns information regarding account balance and credit usage. Information returned is for both master account and all the sub accounts that are below. Total balance can be combined with all the sub accounts below, making it easy to calculate the total. Credit usage is only available per account.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Reports.SubAccountOverviewResponse

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Reports.SubAccountOverviewResponse	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": [
      {
        "AccountLevel": 1,
        "AccountName": "sample string 2",
        "ParentAccountName": "sample string 3",
        "TotalCredits": 4,
        "TotalCreditsInclSubs": 5,
        "MessagesThisMonth": 6,
        "MessagesLastMonth": 7
      },
      {
        "AccountLevel": 1,
        "AccountName": "sample string 2",
        "ParentAccountName": "sample string 3",
        "TotalCredits": 4,
        "TotalCreditsInclSubs": 5,
        "MessagesThisMonth": 6,
        "MessagesLastMonth": 7
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfListOfSubAccountOverviewResponse 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>
      <SubAccountOverviewResponse>
        <AccountLevel>1</AccountLevel>
        <AccountName>sample string 2</AccountName>
        <ParentAccountName>sample string 3</ParentAccountName>
        <TotalCredits>4</TotalCredits>
        <TotalCreditsInclSubs>5</TotalCreditsInclSubs>
        <MessagesThisMonth>6</MessagesThisMonth>
        <MessagesLastMonth>7</MessagesLastMonth>
      </SubAccountOverviewResponse>
      <SubAccountOverviewResponse>
        <AccountLevel>1</AccountLevel>
        <AccountName>sample string 2</AccountName>
        <ParentAccountName>sample string 3</ParentAccountName>
        <TotalCredits>4</TotalCredits>
        <TotalCreditsInclSubs>5</TotalCreditsInclSubs>
        <MessagesThisMonth>6</MessagesThisMonth>
        <MessagesLastMonth>7</MessagesLastMonth>
      </SubAccountOverviewResponse>
    </Detail>
  </ResponseData>
</ResponseOfListOfSubAccountOverviewResponse>