GET api/v1/admin/accounts/{id}/subaccounts?Name={Name}&MobilePhone={MobilePhone}&EmailAddress={EmailAddress}

Returns a list of sub accounts with information of how many credits they have. Filtering can be applied to tackle the specific records.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Account id of the parent account

globally unique identifier

Required

Name

Full name of the sub account

string

None.

MobilePhone

Mobile phone number of the sub account

string

None.

EmailAddress

Email address of the sub account

string

None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfListOfSubAccountResponse
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfListOfSubAccountResponse

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": [
      {
        "ID": "b812d125-719f-4282-99db-21dd87223dbd",
        "Name": "sample string 1",
        "DateCreated": "2017-09-24T12:13:57.7134359Z",
        "AnyTimeBalance": 3.1,
        "OffPeakBalance": 4.1,
        "Enabled": true
      },
      {
        "ID": "b812d125-719f-4282-99db-21dd87223dbd",
        "Name": "sample string 1",
        "DateCreated": "2017-09-24T12:13:57.7134359Z",
        "AnyTimeBalance": 3.1,
        "OffPeakBalance": 4.1,
        "Enabled": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfListOfSubAccountResponse 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>
      <SubAccountResponse>
        <ID>b812d125-719f-4282-99db-21dd87223dbd</ID>
        <Name>sample string 1</Name>
        <DateCreated>2017-09-24T12:13:57.7134359Z</DateCreated>
        <AnyTimeBalance>3.1</AnyTimeBalance>
        <OffPeakBalance>4.1</OffPeakBalance>
        <Enabled>true</Enabled>
      </SubAccountResponse>
      <SubAccountResponse>
        <ID>b812d125-719f-4282-99db-21dd87223dbd</ID>
        <Name>sample string 1</Name>
        <DateCreated>2017-09-24T12:13:57.7134359Z</DateCreated>
        <AnyTimeBalance>3.1</AnyTimeBalance>
        <OffPeakBalance>4.1</OffPeakBalance>
        <Enabled>true</Enabled>
      </SubAccountResponse>
    </Detail>
  </ResponseData>
</ResponseOfListOfSubAccountResponse>