POST v1/RatingTypes

Description

Add a new rating type.

Base Url

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


Rest Call Syntax


POST SecurityMaster/v1/RatingTypes

POST SecurityMaster/v1/RatingTypes

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



RatingTypeAdd

Name

Description

Type

Additional Information

RatingTypeName

The name of the rating type.

string

Required

SortOrder

Sort Order

integer




Limitations

There are no limitations specified.




Request Information


Request body formats


application/json, text/json

Sample:
{
  "ratingTypeName": "sample string 1",
  "sortOrder": 1
}

application/xml, text/xml

Sample:
<RatingTypeAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <RatingTypeName>sample string 1</RatingTypeName>
  <SortOrder>1</SortOrder>
</RatingTypeAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



RatingType

Name

Description

Type

Additional Information

Id

The unique Id of the rating type.

integer

IsDeleted

A flag indicating if the rating type is soft-deleted in the system.

boolean

Links

The Hateoas links to related object

Collection of Link

RatingTypeName

The name of the rating type.

string

SortOrder

The sort order of the Rating type.

integer

Values

The hateoas link to RatingValues




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "ratingTypeName": "sample string 2",
  "sortOrder": 1,
  "isDeleted": true,
  "values": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "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:
<RatingType 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>
  <RatingTypeName>sample string 2</RatingTypeName>
  <SortOrder>1</SortOrder>
  <Values>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Values>
</RatingType>



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.