Coruson API

GetRateLimits

Coruson API Information

The following routes are available for this service:
GET	/api/application/rateLimits	Retrieve Rate Limits for each request	Every request has two different limits. Requests allowed every minute and requests allowed every two seconds. If a limit is set to 0, then there is no limit for this request.

**GetRateLimits** Parameters:
Name	Parameter	Data Type	Required	Description
Resource	query	string	No	Retrieve rate limits for all requests belonging to this resource.

**RequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	int	No

**GetRateLimitsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
RateLimits	form	List<RateLimit>	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
StatusDescription	form	string	No
ResponseStatus	form	ResponseStatus	No

**RateLimit** Parameters:
Name	Parameter	Data Type	Required
Route	form	string	No
Verb	form	string	No
RequestPerMinute	form	int	No
RequestPerTwoSeconds	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

                    POST /jsv/reply/GetRateLimits HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: text/jsv
Content-Length: length

{
	Resource: String,
	Version: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	StatusDescription: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	RateLimits: 
	[
		{
			Route: String,
			Verb: String,
			RequestPerMinute: 0,
			RequestPerTwoSeconds: 0
		}
	]
}