Jump to

• Request
• Response

Create a scoring range

post

/fscmRestApi/resources/11.13.18.05/publicSectorPassingRuleDetails

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:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root 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 these passing rule details apply.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the passing rule details.
• MaximumScore: integer (int32)
  Title: Maximum Score

  The maxiumum inspection score in a range that results in a specified rating.
• MinimumScore: integer (int32)
  Title: Minimum Score

  The minimum inspection score in a range that results in a specified rating.
• NumberMajorViolations: integer (int32)
  Title: Number of Major Violations

  The number of major violations identified in a passing rule, used to determine the inspection result.
• PassingFlag: boolean
  Title: Pass

  Maximum Length: 1

  Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false.
• PassingRule: string
  Title: Passing Rule

  Maximum Length: 15

  The unique identifier for a passing rule.
• SequenceKey: integer (int32)
  Title: Sequence Key

  The secondary key used to make the data for the inspection passing rule details unique.

{
    "type":"object",
    "properties":{
        "MinimumScore":{
            "title":"Minimum Score",
            "type":"integer",
            "description":"The minimum inspection score in a range that results in a specified rating.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the passing rule details.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which these passing rule details apply.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "SequenceKey":{
            "title":"Sequence Key",
            "type":"integer",
            "description":"The secondary key used to make the data for the inspection passing rule details unique.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "PassingRule":{
            "title":"Passing Rule",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for a passing rule.",
            "nullable":false
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"integer",
            "description":"The maxiumum inspection score in a range that results in a specified rating.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "PassingFlag":{
            "title":"Pass",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false.",
            "nullable":false
        },
        "NumberMajorViolations":{
            "title":"Number of Major Violations",
            "type":"integer",
            "description":"The number of major violations identified in a passing rule, used to determine the inspection result.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorPassingRuleDetails-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 these passing rule details apply.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the passing rule details were created.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the passing rule details.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the passing rule details were last modified.
• links: array Links
  Title: Links

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

  The maxiumum inspection score in a range that results in a specified rating.
• MinimumScore: integer (int32)
  Title: Minimum Score

  The minimum inspection score in a range that results in a specified rating.
• NumberMajorViolations: integer (int32)
  Title: Number of Major Violations

  The number of major violations identified in a passing rule, used to determine the inspection result.
• PassingFlag: boolean
  Title: Pass

  Maximum Length: 1

  Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false.
• PassingRule: string
  Title: Passing Rule

  Maximum Length: 15

  The unique identifier for a passing rule.
• SequenceKey: integer (int32)
  Title: Sequence Key

  The secondary key used to make the data for the inspection passing rule details unique.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the passing rule details were created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumScore":{
            "title":"Minimum Score",
            "type":"integer",
            "description":"The minimum inspection score in a range that results in a specified rating.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the passing rule details.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which these passing rule details apply.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SequenceKey":{
            "title":"Sequence Key",
            "type":"integer",
            "description":"The secondary key used to make the data for the inspection passing rule details unique.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PassingRule":{
            "title":"Passing Rule",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for a passing rule.",
            "nullable":false,
            "x-queryable":true
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"integer",
            "description":"The maxiumum inspection score in a range that results in a specified rating.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "PassingFlag":{
            "title":"Pass",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the passing rule details were last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberMajorViolations":{
            "title":"Number of Major Violations",
            "type":"integer",
            "description":"The number of major violations identified in a passing rule, used to determine the inspection result.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "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 : 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."
        }
    }
}

Back to Top