Jump to

• Request
• Response

Get a case code reference

get

/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}

Request

Path Parameters

• CodeReferenceKey(required): integer(int64)
  The unique identifier of the case code reference.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier of the case code reference.
• CaseId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the case.
• CaseKey: integer (int64)
  The unique identifier of the case.
• CasePuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier of the migrated case record.
• ChangeReasonCode: string
  Title: Reason for Update

  Default Value: ORA_ADMIN

  The identifier of the change reason.
• ChangeReasonText: string
  Title: Reason Details

  The description of the change reason.
• CodeReferenceCode: string
  Title: Code Violation

  Maximum Length: 100

  The identifier of the violation code reference.
• CodeReferenceDescription: string (byte)
  The description of the violation code reference.
• CodeReferenceKey: integer (int64)
  The unique identifier of the case code reference.
• CodeReferenceName: string
  Maximum Length: 200

  The name of the violation code reference.
• CodeReferencePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case code reference record.
• Comments: string
  Title: Comments

  Maximum Length: 1000

  The comments associated with the code violation.
• CompliedOn: string (date)
  Title: Complied On

  The date on which the code violation is complied on.
• ComplyBy: string (date)
  Title: Comply By

  The date by which the code violation should be complied on.
• CorrectiveActionCode: string
  Maximum Length: 100

  The identifier of the corrective action.
• CorrectiveActionDescription: string (byte)
  The description of the corrective action.
• CorrectiveActionName: string
  Maximum Length: 200

  The name of the corrective action.
• CreationDate: string (date-time)
  Read Only: true

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

  Maximum Length: 30

  Default Value: ORA_D

  The fee frequency of the code violation.
• FeeRate: number
  Title: Rate

  Default Value: 0

  The fee rate associated with the code violation.
• FeeRecords: array Case Fee Records
  Title: Case Fee Records

  The case fee record resource is used to view, create, or modify a case code violation. Case fee records are used in Code Enforcement cases.
• LastUpdateDate: string (date-time)
  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.
• SourceInspectionKey: integer (int64)
  The unique identifier of the code enforcement inspection.
• SourceInspectionPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated code enforcement inspection record.
• SourceTransactionContext: string
  Maximum Length: 80

  Default Value: ORA_MAN

  The source transaction context type associated with the code violation.
• SourceTransactionContextKey: integer
  The unique identifier of the source transaction context.
• Status: string
  Title: Status

  Maximum Length: 8

  Default Value: ORA_OPEN

  Indicates the status code of the code violation.
• StatusText: string
  Read Only: true

  Maximum Length: 255

  Indicates the status text of the code violation.
• TotalFees: number
  Title: Total Fine

  Read Only: true

  The total fees calculated for the code violation.
• TotalPaidFees: number
  Title: Total Fine Paid

  Read Only: true

  The total fees paid for the code violation.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the case code reference.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "ChangeReasonCode":{
            "title":"Reason for Update",
            "type":"string",
            "description":"The identifier of the change reason.",
            "nullable":true,
            "default":"ORA_ADMIN",
            "x-queryable":false
        },
        "ChangeReasonText":{
            "title":"Reason Details",
            "type":"string",
            "description":"The description of the change reason.",
            "nullable":true,
            "x-queryable":false
        },
        "CodeReferenceCode":{
            "title":"Code Violation",
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the violation code reference.",
            "nullable":false,
            "x-queryable":true
        },
        "CodeReferenceDescription":{
            "type":"string",
            "description":"The description of the violation code reference.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CodeReferenceKey":{
            "type":"integer",
            "description":"The unique identifier of the case code reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CodeReferenceName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the violation code reference.",
            "nullable":true,
            "x-queryable":true
        },
        "CodeReferencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case code reference record.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments associated with the code violation.",
            "nullable":true,
            "x-queryable":true
        },
        "CompliedOn":{
            "title":"Complied On",
            "type":"string",
            "description":"The date on which the code violation is complied on.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ComplyBy":{
            "title":"Comply By",
            "type":"string",
            "description":"The date by which the code violation should be complied on.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CorrectiveActionCode":{
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the corrective action.",
            "nullable":true,
            "x-queryable":true
        },
        "CorrectiveActionDescription":{
            "type":"string",
            "description":"The description of the corrective action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CorrectiveActionName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the corrective action.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeFrequencyUnit":{
            "title":"Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The fee frequency of the code violation.",
            "nullable":false,
            "default":"ORA_D",
            "x-queryable":true
        },
        "FeeRate":{
            "title":"Rate",
            "type":"number",
            "description":"The fee rate associated with the code violation.",
            "nullable":false,
            "default":0,
            "x-queryable":true
        },
        "FeeRecords":{
            "title":"Case Fee Records",
            "type":"array",
            "description":"The case fee record resource is used to view, create, or modify a case code violation. Case fee records are used in Code Enforcement cases.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCaseCodeReferences-FeeRecords-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceInspectionKey":{
            "type":"integer",
            "description":"The unique identifier of the code enforcement inspection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceInspectionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated code enforcement inspection record.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionContext":{
            "maxLength":80,
            "type":"string",
            "description":"The source transaction context type associated with the code violation.",
            "nullable":true,
            "default":"ORA_MAN",
            "x-queryable":false
        },
        "SourceTransactionContextKey":{
            "type":"integer",
            "description":"The unique identifier of the source transaction context.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":8,
            "type":"string",
            "description":"Indicates the status code of the code violation.",
            "nullable":false,
            "default":"ORA_OPEN",
            "x-queryable":true
        },
        "StatusText":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the status text of the code violation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Total Fine",
            "type":"number",
            "description":"The total fees calculated for the code violation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaidFees":{
            "title":"Total Fine Paid",
            "type":"number",
            "description":"The total fees paid for the code violation.",
            "nullable":true,
            "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 : Case Fee Records

Type: array

Title: Case Fee Records

The case fee record resource is used to view, create, or modify a case code violation. Case fee records are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorCaseCodeReferences-FeeRecords-item-response

{
    "title":"Case Fee Records",
    "type":"array",
    "description":"The case fee record resource is used to view, create, or modify a case code violation. Case fee records are used in Code Enforcement cases.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCaseCodeReferences-FeeRecords-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 : publicSectorCaseCodeReferences-FeeRecords-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier of the case fee record.
• AssessedDate: string (date-time)
  Title: Assessed Date

  The date on which the fee was assessed for the case fee record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 3

  Default Value: USD

  The currency code for the case fee record.
• DepartmentId: string
  Maximum Length: 30

  The department identifier of the case fee record.
• DueDate: string (date)
  Title: Due Date

  The due date to pay the case fee.
• FeeAmount: number
  Title: Amount

  The fee amount for the case fee record.
• FeeItemId: string
  Title: Fee Item

  Maximum Length: 30

  The fee item identifier of the case fee record.
• FeeMemo: string
  Title: Comments

  Maximum Length: 500

  The fee comments for the case fee record.
• FeeQuantity: number
  Title: Quantity

  Default Value: 1

  The fee quantity for the case fee record.
• FeeRecordId: string
  Title: Fee Record ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the case fee record.
• FeeRecordKey: integer (int64)
  Read Only: true

  The unique identifier of the case fee record.
• FeeStatus: string
  Title: Status

  Maximum Length: 15

  Default Value: ORA_DUE

  The fee status for the case fee record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingSource: string
  Read Only: true

  Maximum Length: 10

  The mapping source type for the case fee record.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the case fee record.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AssessedDate":{
            "title":"Assessed Date",
            "type":"string",
            "description":"The date on which the fee was assessed for the case fee record.",
            "format":"date-time",
            "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
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency code for the case fee record.",
            "nullable":false,
            "default":"USD",
            "x-queryable":true
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The department identifier of the case fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The due date to pay the case fee.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The fee amount for the case fee record.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item",
            "maxLength":30,
            "type":"string",
            "description":"The fee item identifier of the case fee record.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeMemo":{
            "title":"Comments",
            "maxLength":500,
            "type":"string",
            "description":"The fee comments for the case fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The fee quantity for the case fee record.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "FeeRecordId":{
            "title":"Fee Record ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case fee record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the case fee record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The fee status for the case fee record.",
            "nullable":false,
            "default":"ORA_DUE",
            "x-queryable":true
        },
        "MappingSource":{
            "maxLength":10,
            "type":"string",
            "description":"The mapping source type for the case fee record.",
            "nullable":true,
            "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

FeeRecords

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences/{CodeReferenceKey}/child/FeeRecords

Parameters:

• CodeReferenceKey: $request.path.CodeReferenceKey

The case fee record resource is used to view, create, or modify a case code violation. Case fee records are used in Code Enforcement cases.

Back to Top