Jump to

• Request
• Response

Update a violation notice group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorViolationNoticeGroupsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and NoticeGroupCode ---for the Violation Notice Groups resource and used to uniquely identify an instance of Violation Notice Groups. The client should not generate the hash key value. Instead, the client should query on the Violation Notice Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Violation Notice Groups.
  
  For example: publicSectorViolationNoticeGroups?q=AgencyId=<value1>;NoticeGroupCode=<value2>

Body ()

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

Root Schema : publicSectorViolationNoticeGroups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

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

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Name(optional): string
  Title: Name

  Maximum Length: 200

  The name of the violation notice group.
• NoticeGroupCode(optional): string
  Title: Notice Group ID

  Maximum Length: 100

  The violation notice group code of the record.
• NoticeMappings(optional): array Violation Notice Type Mappings
  Title: Violation Notice Type Mappings

  The violation notice group resource is used to view, create, or modify a violation notice group. Violation notice groups are used in Code Enforcement cases.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the violation notice group is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Name":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the violation notice group.",
            "title":"Name"
        },
        "NoticeGroupCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation notice group code of the record.",
            "title":"Notice Group ID"
        },
        "NoticeMappings":{
            "items":{
                "$ref":"#/definitions/publicSectorViolationNoticeGroups-NoticeMappings-item"
            },
            "type":"array",
            "description":"The violation notice group resource is used to view, create, or modify a violation notice group. Violation notice groups are used in Code Enforcement cases.",
            "title":"Violation Notice Type Mappings"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Violation Notice Type Mappings

Type: array

Title: Violation Notice Type Mappings

The violation notice group resource is used to view, create, or modify a violation notice group. Violation notice groups are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorViolationNoticeGroups-NoticeMappings-item

{
    "items":{
        "$ref":"#/definitions/publicSectorViolationNoticeGroups-NoticeMappings-item"
    },
    "type":"array",
    "description":"The violation notice group resource is used to view, create, or modify a violation notice group. Violation notice groups are used in Code Enforcement cases.",
    "title":"Violation Notice Type Mappings"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorViolationNoticeGroups-NoticeMappings-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the agency.
• CaseStatus(optional): string
  Title: Case Status

  Maximum Length: 15

  The status of the case record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

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

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• NoticeCount(optional): integer(int32)
  Title: Sequence

  The sequence of the notice record.
• NoticeGroupCode(optional): string
  Title: Notice Group ID

  Maximum Length: 100

  The violation notice group code of the record.
• NoticeTypeCode(optional): string
  Title: Notice ID

  Maximum Length: 100

  The violation notice type code of the record.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency.",
            "title":"Agency ID"
        },
        "CaseStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case record.",
            "title":"Case Status"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the violation notice type is available for use in the violation notice group.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "NoticeCount":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence of the notice record.",
            "title":"Sequence"
        },
        "NoticeGroupCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation notice group code of the record.",
            "title":"Notice Group ID"
        },
        "NoticeTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation notice type code of the record.",
            "title":"Notice ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorViolationNoticeGroups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

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

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Name(optional): string
  Title: Name

  Maximum Length: 200

  The name of the violation notice group.
• NoticeGroupCode(optional): string
  Title: Notice Group ID

  Maximum Length: 100

  The violation notice group code of the record.
• NoticeMappings(optional): array Violation Notice Type Mappings
  Title: Violation Notice Type Mappings

  The violation notice group resource is used to view, create, or modify a violation notice group. Violation notice groups are used in Code Enforcement cases.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the violation notice group is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Name":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the violation notice group.",
            "title":"Name"
        },
        "NoticeGroupCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation notice group code of the record.",
            "title":"Notice Group ID"
        },
        "NoticeMappings":{
            "items":{
                "$ref":"#/definitions/publicSectorViolationNoticeGroups-NoticeMappings-item"
            },
            "type":"array",
            "description":"The violation notice group resource is used to view, create, or modify a violation notice group. Violation notice groups are used in Code Enforcement cases.",
            "title":"Violation Notice Type Mappings"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Violation Notice Type Mappings

Type: array

Title: Violation Notice Type Mappings

The violation notice group resource is used to view, create, or modify a violation notice group. Violation notice groups are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorViolationNoticeGroups-NoticeMappings-item

{
    "items":{
        "$ref":"#/definitions/publicSectorViolationNoticeGroups-NoticeMappings-item"
    },
    "type":"array",
    "description":"The violation notice group resource is used to view, create, or modify a violation notice group. Violation notice groups are used in Code Enforcement cases.",
    "title":"Violation Notice Type Mappings"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorViolationNoticeGroups-NoticeMappings-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the agency.
• CaseStatus(optional): string
  Title: Case Status

  Maximum Length: 15

  The status of the case record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

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

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• NoticeCount(optional): integer(int32)
  Title: Sequence

  The sequence of the notice record.
• NoticeGroupCode(optional): string
  Title: Notice Group ID

  Maximum Length: 100

  The violation notice group code of the record.
• NoticeTypeCode(optional): string
  Title: Notice ID

  Maximum Length: 100

  The violation notice type code of the record.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency.",
            "title":"Agency ID"
        },
        "CaseStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case record.",
            "title":"Case Status"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the violation notice type is available for use in the violation notice group.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "NoticeCount":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence of the notice record.",
            "title":"Sequence"
        },
        "NoticeGroupCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation notice group code of the record.",
            "title":"Notice Group ID"
        },
        "NoticeTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation notice type code of the record.",
            "title":"Notice ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top