PUT v1/RatingTypes/{id}/Values/{ratingValueId}

Description

Update rating value with WSO ID of {ratingValueId} for rating type with WSO ID of {id}.

Base Url

https://api-sim.uat.wsohosting.com/


Rest Call Syntax


PUT SecurityMaster/v1/RatingTypes/{id}/Values/{ratingValueId}

PUT SecurityMaster/v1/RatingTypes/{id}/Values/{ratingValueId}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



RatingValueUpdate

Name

Description

Type

Additional Information

Notes

The notes of the RatingValue.

string

RatingValueName

The name of the RatingValue.

string

SortOrder

The sort order of the RatingValue.

integer

Weight

The weight of the RatingValue.

decimal number




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of rating type

integer

Required

ratingValueId

WSO ID of rating value

integer

Required



Request body formats


application/json, text/json

Sample:
{
  "ratingValueName": "sample string 3",
  "sortOrder": 1,
  "weight": 1.1,
  "notes": "sample string 4"
}

application/xml, text/xml

Sample:
<RatingValueUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Notes>sample string 4</Notes>
  <RatingValueName>sample string 3</RatingValueName>
  <SortOrder>1</SortOrder>
  <Weight>1.1</Weight>
</RatingValueUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



RatingValue

Name

Description

Type

Additional Information

Id

The id of the RatingValue.

integer

IsDeleted

True or False - Has this RatingValue been deleted?

boolean

Links

The Hateoas links to related object

Collection of Link

Notes

The notes of the RatingValue.

string

RatingType

The Hateoas Link to the parent RatingType.

RatingTypeName

The rating type name of the RatingValue.

string

RatingValueName

The name of the RatingValue.

string

SortOrder

The sort order of the RatingValue.

integer

Weight

The weight of the RatingValue.

decimal number




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "ratingTypeName": "sample string 3",
  "ratingValueName": "sample string 4",
  "sortOrder": 1,
  "ratingType": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "weight": 1.1,
  "notes": "sample string 5",
  "isDeleted": 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:
<RatingValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <IsDeleted>true</IsDeleted>
  <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>
  <Notes>sample string 5</Notes>
  <RatingType>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </RatingType>
  <RatingTypeName>sample string 3</RatingTypeName>
  <RatingValueName>sample string 4</RatingValueName>
  <SortOrder>1</SortOrder>
  <Weight>1.1</Weight>
</RatingValue>



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.