Get donor’s shareable plans

This GET operation retrieves a list of shareable plans by donorId. If successful, you receive an HTTP response code of 200 and a JSON response listing shareable plans.

See HTTP response codes for other response codes.

GET /sqs/api/shareablePlans/<donorId>

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_SHAREABLE_PLANS_READ_PERMISSION

The JSON response includes the list of shareable plans by planId.

{
   "plans":[
      {
         "planId":6221,
         "planName":"1GB_MONTHLY",
         "recurring": false,
         "shareableAmount":1000,
         "shareableAmountType" : "volume",
         "maxRecipients" : null
      }
   ]
}

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

shareable plan 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