List group member(s)

This GET operation lists all group members in a specified group by passing the group id in the URL. If successful, you receive an HTTP response code of 200 and a JSON response containing a list of all members including their memberId and quota.

See HTTP response codes for other response codes.

GET /sqs/api/groups/<id>/members

HEADER INFO

authorisation: HTTP Basic Auth

tenant: <tenantName>

content-type: application/JSON

accept: application/JSON

By default, accept is XML. You must explicitly set accept in your header to application/JSON to receive a JSON response.

permissions: SQS_GROUP_READ_PERMISSION

URL parameters

Parameter Description

id

The auto-assigned identifier that was given to the group upon creation.


JSON response

The sample JSON response shows two group members in a group specified in the URL GET request.

{
   "_embedded":{
      "members":[
         {
            "memberId":"123123",
            "quota":50000
         },
         {
            "memberId":"567567",
            "quota":100000
         }
      ]
   },
   "page":{
      "size":100,
      "totalElements":2,
      "totalPages":1,
      "number":0
   }
}

SQS members data type descriptions

Field Type Description

memberId

string

The unique ID for the member. This is typically the MSISDN of the subscriber.

The subscriber’s MSISDN in international format.

quota

integer

The quota amount shared with the specified group member. This can be an exact amount or most often, a percentage of the donor plan.

Quota can be volume of data, time, or credit. This is all determined by the unitMeteringType in the donor plan definition.

HTTP response codes

Code Description

200

success!

207

Multistatus response

Check out HTTP statuses for more details.
This is not applicable to all operations.

400

malformed request

401

unauthorised; bad username or password

403

forbidden; user does not have appropriate privileges

404

group member not found

409

conflict with target resource

This often occurs if the item already exists, such as a plan, group, or name.
This is not applicable to all operations.

412

failed validation; this typically means that a property was not set or a value is out of range.

example
HTTP 412
{
  "errors" : [
        {
          "field" : "name",
          "description" : "name is mandatory"
        }
    ]
}

422

failed processing (after passing validation).

example
HTTP 422
{
    "message": "Subscriber max plan count exceeded",
    "errorCode": 1
}
Example 1. SQS response codes

  • 0 = no error

  • 1 = undefined general error

  • 2 = group owner/name pair is not unique

  • 3 = group owner cannot be a member

  • 4 = total member quota exceeds 100%

  • 5 = group does not exist

  • 6 = maximum group size exceeded

  • 7 = the donor does not exist

  • 8 = the shareable plan does not exist

  • 9 = the shareable plan is not a recurring plan

  • 10 = charging group owner unsupported

  • 11 = the recurring donation for this plan already exists

  • 12 = the recipient does not exist

  • 13 = the donor plan max recipient limit was exceeded

  • 14 = subscriber not found

500

internal error

503

request rejected due to overload