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 .xml suffix or ?format=xml

HTTP + XML

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

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

<GetRateLimits xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <Resource>String</Resource>
</GetRateLimits>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetRateLimitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <StatusDescription>String</StatusDescription>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <RateLimits>
    <RateLimit>
      <Route>String</Route>
      <Verb>String</Verb>
      <RequestPerMinute>0</RequestPerMinute>
      <RequestPerTwoSeconds>0</RequestPerTwoSeconds>
    </RateLimit>
  </RateLimits>
</GetRateLimitsResponse>