Jump to

• Request
• Response

Update a violation code reference group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorViolationCodeReferenceGroups-item

Type: object

Show Source

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

  The identifier of the agency.
• CodeReferenceGroupCode(optional): string
  Title: Code Reference Group ID

  Maximum Length: 100

  The violation code reference group code of the record.
• CodeReferences(optional): array Code References
  Title: Code References

  The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases.
• 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.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The description of the violation code reference group.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the violation code reference 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 code reference group.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency.",
            "title":"Agency ID"
        },
        "CodeReferenceGroupCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference group code of the record.",
            "title":"Code Reference Group ID"
        },
        "CodeReferences":{
            "items":{
                "$ref":"#/definitions/publicSectorViolationCodeReferenceGroups-CodeReferences-item"
            },
            "type":"array",
            "description":"The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases.",
            "title":"Code References"
        },
        "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"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The description of the violation code reference group.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the violation code reference 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 code reference group.",
            "title":"Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Code References

Type: array

Title: Code References

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

Show Source

• Array of: object publicSectorViolationCodeReferenceGroups-CodeReferences-item

{
    "items":{
        "$ref":"#/definitions/publicSectorViolationCodeReferenceGroups-CodeReferences-item"
    },
    "type":"array",
    "description":"The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases.",
    "title":"Code References"
}

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 : publicSectorViolationCodeReferenceGroups-CodeReferences-item

Type: object

Show Source

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

  The identifier of the agency.
• CodeReferenceCode(optional): string
  Title: Code Reference ID

  Maximum Length: 100

  The violation code reference code of the record.
• CodeReferenceGroupCode(optional): string
  Title: Code Reference Group ID

  Maximum Length: 100

  The violation code reference group code of the 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 code reference is available for use in the 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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency.",
            "title":"Agency ID"
        },
        "CodeReferenceCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference code of the record.",
            "title":"Code Reference ID"
        },
        "CodeReferenceGroupCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference group code of the record.",
            "title":"Code Reference Group 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 code reference is available for use in the 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"
        },
        "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 : 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"
}

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 : publicSectorViolationCodeReferenceGroups-item

Type: object

Show Source

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

  The identifier of the agency.
• CodeReferenceGroupCode(optional): string
  Title: Code Reference Group ID

  Maximum Length: 100

  The violation code reference group code of the record.
• CodeReferences(optional): array Code References
  Title: Code References

  The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases.
• 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.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The description of the violation code reference group.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the violation code reference 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 code reference group.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency.",
            "title":"Agency ID"
        },
        "CodeReferenceGroupCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference group code of the record.",
            "title":"Code Reference Group ID"
        },
        "CodeReferences":{
            "items":{
                "$ref":"#/definitions/publicSectorViolationCodeReferenceGroups-CodeReferences-item"
            },
            "type":"array",
            "description":"The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases.",
            "title":"Code References"
        },
        "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"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The description of the violation code reference group.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the violation code reference 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 code reference group.",
            "title":"Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Code References

Type: array

Title: Code References

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

Show Source

• Array of: object publicSectorViolationCodeReferenceGroups-CodeReferences-item

{
    "items":{
        "$ref":"#/definitions/publicSectorViolationCodeReferenceGroups-CodeReferences-item"
    },
    "type":"array",
    "description":"The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases.",
    "title":"Code References"
}

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 : publicSectorViolationCodeReferenceGroups-CodeReferences-item

Type: object

Show Source

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

  The identifier of the agency.
• CodeReferenceCode(optional): string
  Title: Code Reference ID

  Maximum Length: 100

  The violation code reference code of the record.
• CodeReferenceGroupCode(optional): string
  Title: Code Reference Group ID

  Maximum Length: 100

  The violation code reference group code of the 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 code reference is available for use in the 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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency.",
            "title":"Agency ID"
        },
        "CodeReferenceCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference code of the record.",
            "title":"Code Reference ID"
        },
        "CodeReferenceGroupCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference group code of the record.",
            "title":"Code Reference Group 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 code reference is available for use in the 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"
        },
        "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 : 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"
}

Back to Top