Get Rate Limits for a Consumer
GET /obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/call-limits
OBPv3.1.0-getCallsLimit Roles: CanReadCallLimits Consumer
Get Rate Limits per Consumer. User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields (15)
- per_day_call_limit
- per_hour_call_limit
- per_minute_call_limit
- per_month_call_limit
- per_second_call_limit
- 10
- per_week_call_limit
- calls_made
- 50
- current_state
- per_day
- 4000
- per_hour
- per_minute
- per_month
- 500
- per_second
- 1000
- per_week
- 50000
- reset_in_seconds
Example success response
{
"per_second_call_limit": "-1",
"per_minute_call_limit": "-1",
"per_hour_call_limit": "-1",
"per_day_call_limit": "-1",
"per_week_call_limit": "-1",
"per_month_call_limit": "-1",
"current_state": {
"per_second": {
"calls_made": -1,
"reset_in_seconds": -1
},
"per_minute": {
"calls_made": -1,
"reset_in_seconds": -1
},
"per_hour": {
"calls_made": -1,
"reset_in_seconds": -1
},
"per_day": {
"calls_made": -1,
"reset_in_seconds": -1
},
"per_week": {
"calls_made": -1,
"reset_in_seconds": -1
},
"per_month": {
"calls_made": -1,
"reset_in_seconds": -1
}
}
}Possible errors (7)
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
- OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
- OBP-20006: User is missing one or more roles:
- OBP-30023: Cannot update Consumer
- OBP-50000: Unknown Error.