POST v1/Facilities/{id}/Ratings

Description

add a rating for facility with a WSO ID of {id}

Base Url

https://services.wsoweb.com/


Rest Call Syntax


POST SecurityMaster/v1/Facilities/{id}/Ratings

POST SecurityMaster/v1/Facilities/{id}/Ratings

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



RatingAdd

Name

Description

Type

Additional Information

RatingValueId

The WSO ID of the rating value

integer

Required

IsAtIssuance

The flag indicating if the rating has applied since the issuance of the entity

boolean

IsProvisional

The flag indicating if the rating is provisional

boolean

IsTerminatingValue

When set to true, the system will add new rating only if an active rating exists for the given rating type.

boolean

StartDate

The start date of the rating value

date




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of facility

integer

Required



Request body formats


application/json, text/json

Sample:
{
  "isAtIssuance": true,
  "isProvisional": true,
  "ratingValueId": 3,
  "startDate": "2024-11-23T01:44:53.3099703-06:00",
  "isTerminatingValue": true
}

application/xml, text/xml

Sample:
<RatingAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <IsAtIssuance>true</IsAtIssuance>
  <IsProvisional>true</IsProvisional>
  <IsTerminatingValue>true</IsTerminatingValue>
  <RatingValueId>3</RatingValueId>
  <StartDate>2024-11-23T01:44:53.3099703-06:00</StartDate>
</RatingAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



Rating

Name

Description

Type

Additional Information

AddDate

Gets or sets the date that this record was added.

date

AddId

Gets or sets the name of the user who added this record to the system.

string

AddNode

Gets or sets the name of the machine that added this record to the system.

string

Id

The WSO ID for the rating

integer

IsAtIssuance

The flag indicating if the rating has applied since the issuance of the entity

boolean

IsProvisional

The flag indicating if the rating is provisional

boolean

LastChangeDate

Gets or sets the date of the last change to this record.

date

LastChangeId

Gets or sets the name of the user that last made changes to this record.

string

LastChangeNode

Gets or sets the name of the machine that last made changes to this record.

string

Links

A list of links

Collection of Link

RatingType

The name of the rating type

string

RatingValue

The value for a rating type

string

StartDate

The start date for the rating value

date




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "isAtIssuance": true,
  "isProvisional": true,
  "ratingValue": "sample string 4",
  "ratingType": "sample string 5",
  "startDate": "2024-11-23T01:44:53.3099703-06:00",
  "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"
    }
  ],
  "addId": "sample string 9",
  "addNode": "sample string 10",
  "addDate": "2024-11-23T01:44:53.3099703-06:00",
  "lastChangeId": "sample string 12",
  "lastChangeNode": "sample string 13",
  "lastChangeDate": "2024-11-23T01:44:53.3099703-06:00"
}

application/xml, text/xml

Sample:
<Rating xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddDate>2024-11-23T01:44:53.3099703-06:00</AddDate>
  <AddId>sample string 9</AddId>
  <AddNode>sample string 10</AddNode>
  <Id>1</Id>
  <IsAtIssuance>true</IsAtIssuance>
  <IsProvisional>true</IsProvisional>
  <LastChangeDate>2024-11-23T01:44:53.3099703-06:00</LastChangeDate>
  <LastChangeId>sample string 12</LastChangeId>
  <LastChangeNode>sample string 13</LastChangeNode>
  <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>
  <RatingType>sample string 5</RatingType>
  <RatingValue>sample string 4</RatingValue>
  <StartDate>2024-11-23T01:44:53.3099703-06:00</StartDate>
</Rating>



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.