Non TMF Biz Api

/subscribers/{subscriberNumber} [GET]

To get Subscriber Loan Configutaion Details.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

https://[localhost]:[port]/nontmf-biz/v1/{businessId}/subscribers/{subscriberNumber}

URL PARAMS

Header

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - request processed successfully, response body contains an entity corresponding to the requested resource.

{
    "businessId":"BB",
    "subscriberNumber": "18768125891",
    "loyaltyClass": "Beginner",
    "pointsBalance": "1.0",
    "nextLoyaltyClass": "Silver",
    "nextClassPointsThreshold": "5.0",
    "lowCoreBalanceThreshold": "5.0",
    "currencyCode": "BBD"
}

Definitions

Each of the response parameters is detailed.

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The client sent too many requests and server is not able to serve them all at the moment"
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method post not allowed for : /subscribers/{subscriberNumber}/"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": ""
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation GET /xxxx/xxxxxx for Business Id: xxxx not implemented"
    }]
  }

Administration and data management

In this section you define all the transformations, temporary and final repositories of the data within the method flow.

Transformation Request

In this section the matrix of all the data transformations that is carried out within the service is defined.

nontmf-evolving-sys

Transformation Response

In this section the matrix of all the data transformations that is carried out within the service is defined.

nontmf-evolving-sys

note: Same SYS response without transformation

Services dependencies

This section defines all the connections to the web services and the methods that are used within the method.

nontmf-evolving-sys