Additional Use Cases

Eligibility

GTAF MAY issue the following eligibility request to check whether a user is eligible to purchase a plan.

GET DPA/{userKey}/Eligibility/{planId}?key_type={CPID,MSISDN}

Note that planId is the unique identifier for the plan that can be used to purchase the plan on behalf of the user (See Data Purchase). If planId is not specified the DPA MUST return all plans purchasable by that user.

Error cases lists the responses expected from DPA in case of an error. Additionally, the DPA SHALL return an error in the following error cases:

  • The DPA returns a 400 BAD REQUEST error code indicating to GTAF that planId is invalid.
  • The DPA returns a 409 CONFLICT error code indicating that planId is incompatible with the user's data plan.

Otherwise, the DPA SHALL return a 200-OK response. The format of a successful EligibilityResponse is:

{
  "eligiblePlans":
  [
   {
    "planId": string,   // Plan identifier. Can be used to
                        // refer to the plan during
                        // offers, etc. (req.)
   }
  ]
}

When the request includes a planId the response includes only that plan. Otherwise, the list includes all the plans the user is eligible to purchase. In the case where planId is empty and the DPA does not support returning the list of eligible plans it MUST return a 400 BAD REQUEST error.