Jump to

• Request
• Response

Update a violation code reference group

patch

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

Request

Path Parameters

• publicSectorViolationCodeReferenceGroupsUniqID(required): string
  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>

Header Parameters

• Metadata-Context: string
  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: string
  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 ()

Root Schema : schema

Type: object

Show Source

• CodeReferences: array Code References
  Title: Code References

  The code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases.
• Description: string
  Title: Description

  Maximum Length: 500

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

  Maximum Length: 1

  Default Value: true

  Indicates whether the violation code reference group is available for use.
• Name: string
  Title: Name

  Maximum Length: 200

  The name of the violation code reference group.

{
    "type":"object",
    "properties":{
        "CodeReferences":{
            "title":"Code References",
            "type":"array",
            "description":"The code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases.",
            "items":{
                "$ref":"#/components/schemas/publicSectorViolationCodeReferenceGroups-CodeReferences-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The description of the violation code reference group.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the violation code reference group is available for use.",
            "nullable":false,
            "default":true
        },
        "Name":{
            "title":"Name",
            "maxLength":200,
            "type":"string",
            "description":"The name of the violation code reference group.",
            "nullable":false
        }
    }
}

Nested Schema : Code References

Type: array

Title: Code References

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

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the violation code reference is available for use in the group.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the violation code reference is available for use in the group.",
            "nullable":false,
            "default":true
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 100

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

  The code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the row was created.
• Description: string
  Title: Description

  Maximum Length: 500

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

  Maximum Length: 1

  Default Value: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 200

  The name of the violation code reference group.

{
    "type":"object",
    "properties":{
        "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
        },
        "CodeReferenceGroupCode":{
            "title":"Code Reference Group ID",
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference group code of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "CodeReferences":{
            "title":"Code References",
            "type":"array",
            "description":"The code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases.",
            "items":{
                "$ref":"#/components/schemas/publicSectorViolationCodeReferenceGroups-CodeReferences-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "Description":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The description of the violation code reference group.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the violation code reference group is available for use.",
            "nullable":false,
            "default":true,
            "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":200,
            "type":"string",
            "description":"The name of the violation code reference group.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Code References

Type: array

Title: Code References

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

Show Source

• Array of: object publicSectorViolationCodeReferenceGroups-CodeReferences-item-response

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

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 100

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

  Maximum Length: 100

  The violation code reference group code of the record.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• 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 code reference is available for use in the group.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "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
        },
        "CodeReferenceCode":{
            "title":"Code Reference ID",
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference code of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "CodeReferenceGroupCode":{
            "title":"Code Reference Group ID",
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference group code of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the violation code reference is available for use in the group.",
            "nullable":false,
            "default":true,
            "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Links

CodeReferences

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}/child/CodeReferences

Parameters:

• publicSectorViolationCodeReferenceGroupsUniqID: $request.path.publicSectorViolationCodeReferenceGroupsUniqID

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

Back to Top