PUT v1/Facilities/{id}/RateLimits/{rateLimitId}

Description

Update rate limit with WSO ID of {rateLimitId} for facility with WSO ID of {id}.

Base Url

https://api-agc.wsohosting.com/


Rest Call Syntax


PUT SecurityMaster/v1/Facilities/{id}/RateLimits/{rateLimitId}

PUT SecurityMaster/v1/Facilities/{id}/RateLimits/{rateLimitId}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



RateLimitUpdate

Name

Description

Type

Additional Information

Limit

The limit value

decimal number

Limit cannot be negative

LimitType

The limit type

Required

RateType

The rate type

Required

IncludeSpreadAdjustment

boolean




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of facility

integer

Required

rateLimitId

WSO ID of rate limit

integer

Required



Request body formats


application/json, text/json

Sample:
{
  "limit": 1.1,
  "limitType": "Cap",
  "rateType": "All_InRate",
  "includeSpreadAdjustment": true
}

application/xml, text/xml

Sample:
<RateLimitUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <IncludeSpreadAdjustment>true</IncludeSpreadAdjustment>
  <Limit>1.1</Limit>
  <LimitType>Cap</LimitType>
  <RateType>All_InRate</RateType>
</RateLimitUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



RateLimit

Name

Description

Type

Additional Information

FacilityRateOptionId

The rate option listed by WSO ID

integer

Id

The WSO ID for the rate limit

integer

IncludeSpreadAdjustment

boolean

Limit

The limit for the rate limit

decimal number

LimitType

The limit type - 1 = Cap; 2 = Floor

Links

A list of links

Collection of Link

RateType

The rate type




Response Body Formats



application/json, text/json

Sample:
{
  "limit": 2.1,
  "limitType": "Cap",
  "facilityRateOptionId": 3,
  "id": 4,
  "rateType": "All_InRate",
  "includeSpreadAdjustment": true,
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ]
}

application/xml, text/xml

Sample:
<RateLimit xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <FacilityRateOptionId>3</FacilityRateOptionId>
  <Id>4</Id>
  <IncludeSpreadAdjustment>true</IncludeSpreadAdjustment>
  <Limit>2.1</Limit>
  <LimitType>Cap</LimitType>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <RateType>All_InRate</RateType>
</RateLimit>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.