Jump to

• Request
• Response

Update an ad hoc violation notice type in a violation notice group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorViolationAdhocNotices/{publicSectorViolationAdhocNoticesUniqID}

Request

Path Parameters

• publicSectorViolationAdhocNoticesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, NoticeGroupCode and NoticeTypeCode ---for the Violation Ad Hoc Notices resource and used to uniquely identify an instance of Violation Ad Hoc Notices. The client should not generate the hash key value. Instead, the client should query on the Violation Ad Hoc Notices collection resource with a filter on the primary key values in order to navigate to a specific instance of Violation Ad Hoc Notices.
  
  For example: publicSectorViolationAdhocNotices?q=AgencyId=<value1>;NoticeGroupCode=<value2>;NoticeTypeCode=<value3>

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.

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

• CategoryCode: string
  Title: Ad Hoc Notice Category

  Maximum Length: 30

  The user defined category identifier of an ad hoc notice.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the violation notice type is available for use in the violation notice group.
• NoticeCount: integer (int32)
  Title: Count

  The user defined sequence number assigned to a notice.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Ad Hoc Notice Category",
            "maxLength":30,
            "type":"string",
            "description":"The user defined category identifier of an ad hoc notice.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the violation notice type is available for use in the violation notice group.",
            "nullable":false,
            "default":true
        },
        "NoticeCount":{
            "title":"Count",
            "type":"integer",
            "description":"The user defined sequence number assigned to a notice.",
            "format":"int32",
            "nullable":true,
            "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(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 : publicSectorViolationAdhocNotices-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier of the agency.
• CategoryCode: string
  Title: Ad Hoc Notice Category

  Maximum Length: 30

  The user defined category identifier of an ad hoc notice.
• CategoryCodeName: string
  Title: Category Name

  Read Only: true

  Maximum Length: 255

  The user defined category name of an ad hoc notice.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the violation notice type is available for use in the violation notice group.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoticeCount: integer (int32)
  Title: Count

  The user defined sequence number assigned to a notice.
• NoticeGroupCode: string
  Title: Group ID

  Maximum Length: 100

  The violation notice group code of the record.
• NoticeTypeCode: string
  Title: ID

  Maximum Length: 100

  The violation notice type code of the record.
• NoticeTypeName: string
  Title: Name

  Read Only: true

  Maximum Length: 255

  The violation notice type of the record.

{
    "type":"object",
    "properties":{
        "NoticeTypeName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The violation notice type of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Ad Hoc Notice Category",
            "maxLength":30,
            "type":"string",
            "description":"The user defined category identifier of an ad hoc notice.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "NoticeGroupCode":{
            "title":"Group ID",
            "maxLength":100,
            "type":"string",
            "description":"The violation notice group code of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "NoticeTypeCode":{
            "title":"ID",
            "maxLength":100,
            "type":"string",
            "description":"The violation notice type code of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryCodeName":{
            "title":"Category Name",
            "maxLength":255,
            "type":"string",
            "description":"The user defined category name of an ad hoc notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the violation notice type is available for use in the violation notice group.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "NoticeCount":{
            "title":"Count",
            "type":"integer",
            "description":"The user defined sequence number assigned to a notice.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "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 : 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