Jump to

• Request
• Response

Create a rating method

post

/fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier for the public sector entity to which this rating method applies.
• Description(required): string
  Title: Description

  Maximum Length: 100

  The description of the rating method.
• RatingMethod(required): string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).
• RatingMethodDetail: array Rating Method Details
  Title: Rating Method Details

  The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

{
    "required":[
        "Description",
        "RatingMethod"
    ],
    "type":"object",
    "properties":{
        "RatingMethod":{
            "title":"Rating Method",
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the rating method.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier for the public sector entity to which this rating method applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "RatingMethodDetail":{
            "title":"Rating Method Details",
            "type":"array",
            "description":"The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRatingMethods-RatingMethodDetail-item-post-request"
            }
        }
    }
}

Nested Schema : Rating Method Details

Type: array

Title: Rating Method Details

The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

Show Source

• Array of: object schema

{
    "title":"Rating Method Details",
    "type":"array",
    "description":"The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRatingMethods-RatingMethodDetail-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this rating range of scores applies.
• MaximumScore: integer (int32)
  Title: Maximum Score

  The maximum numerical value to specify the range of scores for this rating.
• MinimumScore: integer (int32)
  Title: Minimum Score

  The minimum numerical value to specify the range of scores for this rating.
• Rating: string
  Title: Rating

  Maximum Length: 5

  The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.
• RatingMethod: string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).

{
    "type":"object",
    "properties":{
        "MinimumScore":{
            "title":"Minimum Score",
            "type":"integer",
            "description":"The minimum numerical value to specify the range of scores for this rating.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "RatingMethod":{
            "title":"Rating Method",
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this rating range of scores applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"integer",
            "description":"The maximum numerical value to specify the range of scores for this rating.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "Rating":{
            "title":"Rating",
            "maxLength":5,
            "type":"string",
            "description":"The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorRatingMethods-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier for the public sector entity to which this rating method applies.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the rating method.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the rating method was created.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the rating method.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the rating method was last modified.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last modified the rating method.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RatingMethod: string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).
• RatingMethodDetail: array Rating Method Details
  Title: Rating Method Details

  The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the rating method.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the rating method was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rating method.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the rating method.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier for the public sector entity to which this rating method applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RatingMethod":{
            "title":"Rating Method",
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "nullable":false,
            "x-queryable":true
        },
        "RatingMethodDetail":{
            "title":"Rating Method Details",
            "type":"array",
            "description":"The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRatingMethods-RatingMethodDetail-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the rating method was last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Rating Method Details

Type: array

Title: Rating Method Details

The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

Show Source

• Array of: object publicSectorRatingMethods-RatingMethodDetail-item-response

{
    "title":"Rating Method Details",
    "type":"array",
    "description":"The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRatingMethods-RatingMethodDetail-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : publicSectorRatingMethods-RatingMethodDetail-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this rating range of scores applies.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the rating method details.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the rating method details were created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the rating method details were last modified.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last modified the rating method details.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumScore: integer (int32)
  Title: Maximum Score

  The maximum numerical value to specify the range of scores for this rating.
• MinimumScore: integer (int32)
  Title: Minimum Score

  The minimum numerical value to specify the range of scores for this rating.
• Rating: string
  Title: Rating

  Maximum Length: 5

  The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.
• RatingMethod: string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the rating method details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the rating method details were created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumScore":{
            "title":"Minimum Score",
            "type":"integer",
            "description":"The minimum numerical value to specify the range of scores for this rating.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rating method details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this rating range of scores applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Rating":{
            "title":"Rating",
            "maxLength":5,
            "type":"string",
            "description":"The short name for a rating. For example, if the rating method assigns letter grades, the rating name is the actual letter grade, such as A, B, or C.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RatingMethod":{
            "title":"Rating Method",
            "maxLength":15,
            "type":"string",
            "description":"The unique code to identify the rating method used to produce an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "nullable":false,
            "x-queryable":true
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"integer",
            "description":"The maximum numerical value to specify the range of scores for this rating.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the rating method details were last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

RatingMethodDetail

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRatingMethods/{publicSectorRatingMethodsUniqID}/child/RatingMethodDetail

Parameters:

• publicSectorRatingMethodsUniqID: $request.path.publicSectorRatingMethodsUniqID

The rating method details resource is used for view, create, or modify the rating method details. The rating method details include the rating names and score ranges that make up a rating method.

Back to Top