dxp-ux

listProduct [GET]

1. The listProduct API is used to retrieve a list of purchased products and Subscriber status for LCPR.
2. This operation allows to fetch the entitlement report from bango for PA.

URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/product

URL Parameter

Headers

Query Parameter

Data Model - Response

productCharacteristic subResource - Data Model

product.productCharacteristic subResource - Data Model

Key considerations

• Please refer the examples from the following URL - DXP UX - GET Product

PA Implementation (bango usecase)::

1. ‘@type’ queryParam should always be “OTT”.
2. Possible values for 'status' queryParam are active, cancelled,aborted, suspended,pendingActive.
3. Possible status from in the response from Bango are below mentioned

PR Implementation::

For LCPR prepaid customers

• API returns all products/subscriptions along with status.
• We can use this API to check if the customer number(MSISDN) is active or not. In response, if payload[x].@type=subscription and payload[x].status=Active it means MSISDN is active.

Possible Error Scenarios for PA:

IF WE ARE PASSING INVALID (@type) IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:INVALID_BOOLEAN",
            "description": "Mandatory field @type is not specified or Incorrect value is received. The expected value is OTT"
        }
    ]
}

Possible Error Scenarios for PR:

IF WE ARE PASSING INVALID (publicIdentifier) IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "MATRIXX:PRODUCTINVENTORY_REPORT",
            "description": "11 | Subscriber not found (AccessNumber=8919414206)"
        }
    ]
}

IF WE ARE PASSING INVALID (publicIdentifierType) IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:MISMATCH",
            "description": "PublicIdentifierType is not valid. Expected values are : SubscriptionId | MSISDN"
        }
    ]
}

IF WE ARE PASSING INVALID CHANNELID

{
    "errors": [
        {
            "code": 501,
            "message": "LLA:NOT_IMPLEMENTED",
            "description": "There is no Implementation available for this BU"
        }
    ]
}

IF WE ARE PASSING INVALID SECURITY HEADERS

{
    "error": "Invalid Client"
}