Non TMF Biz Api

/billingAccount/{id}/loyaltyPoints [GET]

This operation retrieves a loyalty points summary of a particular Account.

Request

URL

https://[localhost]:[port]/nontmf-biz/v1/{businessId}/billingAccount/{id}/loyaltyPoints

Base URI Parameter

Headers

Security Headers

Possible success response

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.

HTTP Status response is 200 with Response body.

{
  "loyaltyPointsSummaryItem": {
        "lpBillAvailable": "0",
        "lpBillCalcDt": "2022-02-01T00:00:00-04:00",
        "lpBillEarned": "0",
        "lpBillExpired": "0",
        "lpBillPrevious": "0",
        "lpBillSpentPrev": "0",
        "lpBillTotal": "0",
        "lpBillWillExpire": "0",
        "lpMemberYn": "false",
        "lpNowAvailable": "0",
        "lpNowAwarded": "0",
        "lpNowSpent": "0"
  }
}

Possible error response

[ 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": "APIKIT:BAD_REQUEST",
            "description": "Required header 'client_id' not specified"
        }
    ]
}

[ 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 : /{businessId}/billingAccount/{id}/loyaltyPoints"
        }]
}

[ 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 /billingAccount/{id}/loyaltyPoints for Business Id: xxxx not implemented"
    }]
  }

[ 503 ]

service unavailable (503).

{
    "errors": [
        {
            "code": 503,
            "message": "HTTP:SERVICE_UNAVAILABLE",
            "description": "HTTP GET on resource 'http://0.0.0.0:9092/cerillion-nontmf-sys/v1/{businessId}/billingAccount/{billingAccountId}/loyaltyPoints' failed: service unavailable (503)."
        }
    ]
}

Request

URL

http://host:port/cerillion-nontmf-sys/v1/{businessId}/billingAccount/{billingAccountId}/loyaltyPoints

Primary Flow

Transformations or Mappings

process layer (biz) have neither transformations nor mappings, instead it has data model representation for the response which is delivered to client.

BaseUriParameter

Headers

Security Headers

Cache

Not Applicable

Performance Considerations

Not Applicable

Audit Implementation

Events should be generated when starting to process each of the request and when the processing of the requests is finished, indicating whether the operation was successful.

Database Changes

No Data base Changes are part of this implementations

Network/Infrastructure changes

No network Changes are part of this implementations

3rd Party Interactions

Not Applicable

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.

Transformation Response

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

Services dependencies

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

cerillion-nontmf-sys