Jump to

• Request
• Response

Get a case

get

/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}

Request

Path Parameters

• CaseKey(required): integer(int64)
  The unique identifier of the case.

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:
  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.

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

Type: object

Show Source

• AccessCode: string
  Title: Access Number

  Maximum Length: 5

  The access code of the case.
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency of the case.
• AppealDueDate: string (date)
  Title: Appeal By

  The last date by which a user is allowed to submit an appeal for the case.
• AssignedId: integer (int64)
  Title: Inspector Assigned

  The unique identifier of the code officer assigned to the case.
• AssignedPuid: string
  The public unique identifier of the code officer assigned to the case.
• CaseCodeReference: array Code Violation
  Title: Code Violation

  The code violation resource is used to view the code violation associated with a case.
• CaseId: string
  Title: Case ID

  Maximum Length: 50

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

  The public unique identifier of the migrated case record.
• ChangeReason: string
  The reason for modifying the case.
• ClosedBy: string
  Title: Closed By

  Maximum Length: 64

  The name of the user who closed the case.
• ClosedDate: string (date-time)
  Title: Closed On

  The date when the case was closed.
• ClosedReason: string
  Title: Reason for Closing

  Maximum Length: 450

  The reason for closing the case.
• ComplianceDueDate: string (date)
  Title: Compliance Date

  The compliance date of the case.
• CompliedOn: string (date)
  The date on which the code violation of the case was complied on.
• 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.
• CriticalFlag: boolean
  Title: Critical

  Maximum Length: 1

  Default Value: false

  The switch to indicate that the case is critical.
• DistrictId: string
  Maximum Length: 30

  The unique identifier of the district of the location of the case.
• DistrictType: string
  Title: District Type

  Maximum Length: 50

  The type of district associated with the case.
• FunctionalStatus: string
  Maximum Length: 15

  The user defined case status name that maps to a delivered system status.
• InspectionActDate: string (date)
  The completion date of the case inspection.
• IntakeKey: integer (int64)
  Read Only: true

  The unique identifier of the intake.
• IntakePuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier of the migrated intake record.
• IntakeSource: string
  Maximum Length: 30

  Default Value: ORA_CS

  The source of the case intake.
• InternalPriority: string
  Title: Internal Priority

  Maximum Length: 30

  Default Value: ORA_N

  The internal priority of the case.
• IssueDescription: string
  Title: Issue Description

  Maximum Length: 1000

  The description of the issue.
• IssueSubtype: string
  Title: Issue Subtype

  Read Only: true

  Maximum Length: 100

  The name of the issue subtype associated with the case.
• IssueSubtypeId: string
  Maximum Length: 50

  The unique identifier of the issue subtype of the case.
• IssueType: string
  Title: Issue Type

  Read Only: true

  Maximum Length: 100

  The name of the issue type associated with the case.
• IssueTypeId: string
  Maximum Length: 50

  The unique identifier of the issue type of the case.
• 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.
• Latitude: number
  The latitude of the location of the case.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDescription: string
  Title: Location Description

  Maximum Length: 1000

  The description of the location.
• Longitude: number
  The longitude of the location of the case.
• ObsoleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  The switch to indicate that the case is obsolete.
• ParcelIdEntered: string
  Maximum Length: 30

  The unique identifier of the parcel retrieved from the map for the case.
• Priority: string
  Title: Priority

  Maximum Length: 30

  Default Value: ORA_N

  The priority of the case.
• PropertyAddress1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the property address of the case.
• PropertyAddress2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the property address of the case.
• PropertyAddress3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the property address of the case.
• PropertyAddress4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the property address of the case.
• PropertyAddressId: integer (int64)
  The unique identifier of the property address of the case.
• PropertyCity: string
  Title: City

  Maximum Length: 60

  The city of the property address of the case.
• PropertyCoordinateX: number
  The x-coordinate of the property address of the case.
• PropertyCoordinateY: number
  The y-coordinate of the property address of the case.
• PropertyCountry: string
  Title: Country

  Maximum Length: 3

  The country of the property address of the case.
• PropertyCounty: string
  Maximum Length: 60

  The county of the property address of the case.
• PropertyOwnerId: integer
  The unique identifier of the property owner of the case.
• PropertyParcelId: integer (int64)
  The unique identifier of the property parcel of the case.
• PropertyPostalCode: string
  Maximum Length: 60

  The postal code of the property address of the case.
• PropertyPostalPlusFourCode: string
  Maximum Length: 10

  The postal plus code of the property address of the case.
• PropertyProvince: string
  Maximum Length: 60

  The province of the property address of the case.
• PropertyState: string
  Title: State Name

  Maximum Length: 60

  The state of the property address of the case.
• ReferralCode: string
  Title: Referred To

  Maximum Length: 100

  The unique identifier of the referral body of the case.
• ReportedById: string
  Title: Reported By

  Maximum Length: 64

  The unique identifier of the person who reported the case.
• ReviewerId: integer (int64)
  Title: Technician Assigned

  The unique identifier of the code technician assigned to the case.
• ReviewerPuid: string
  The public unique identifier of the code technician assigned to the case.
• Shape: object Shape
  Read Only: true

  The shape of the property associated with the case.
• SourceTransactionPuid: string
  The public unique identifier of the migrated source transaction record.
• SourceTrxId: string
  Maximum Length: 50

  The unique identifier of the source transaction that created the case.
• Status: string
  Title: Case Status

  Maximum Length: 15

  Default Value: ORA_VIO

  The status of the case.
• StatusDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 30

  The description of the status of the case.
• SubmitDate: string (date-time)
  Title: Submitted On

  The date when the case was submitted.
• UpdateAllComplyBy: string
  Maximum Length: 80

  Default Value: N

  The indicator to update the code violation comply by date.

{
    "type":"object",
    "properties":{
        "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
        },
        "PropertyParcelId":{
            "type":"integer",
            "description":"The unique identifier of the property parcel of the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferralCode":{
            "title":"Referred To",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the referral body of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedPuid":{
            "type":"string",
            "description":"The public unique identifier of the code officer assigned to the case.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submitted On",
            "type":"string",
            "description":"The date when the case was submitted.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ReviewerPuid":{
            "type":"string",
            "description":"The public unique identifier of the code technician assigned to the case.",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the location of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "CompliedOn":{
            "type":"string",
            "description":"The date on which the code violation of the case was complied on.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated source transaction record.",
            "nullable":true,
            "x-queryable":true
        },
        "IntakeSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The source of the case intake.",
            "nullable":false,
            "default":"ORA_CS",
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "ClosedReason":{
            "title":"Reason for Closing",
            "maxLength":"450",
            "type":"string",
            "description":"The reason for closing the case.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeReason":{
            "type":"string",
            "description":"The reason for modifying the case.",
            "nullable":true,
            "x-queryable":false
        },
        "PropertyProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"The province of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDescription":{
            "title":"Location Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusDescription":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the status of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the parcel retrieved from the map for the case.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InspectionActDate":{
            "type":"string",
            "description":"The completion date of the case inspection.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateAllComplyBy":{
            "maxLength":"80",
            "type":"string",
            "description":"The indicator to update the code violation comply by date.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "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
        },
        "Status":{
            "title":"Case Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the case.",
            "nullable":false,
            "default":"ORA_VIO",
            "x-queryable":true
        },
        "FunctionalStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status.",
            "nullable":true,
            "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
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DistrictType":{
            "title":"District Type",
            "maxLength":"50",
            "type":"string",
            "description":"The type of district associated with the case.",
            "nullable":true,
            "x-queryable":true
        },
        "IntakePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated intake record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"The priority of the case.",
            "nullable":false,
            "default":"ORA_N",
            "x-queryable":true
        },
        "InternalPriority":{
            "title":"Internal Priority",
            "maxLength":"30",
            "type":"string",
            "description":"The internal priority of the case.",
            "nullable":false,
            "default":"ORA_N",
            "x-queryable":true
        },
        "AccessCode":{
            "title":"Access Number",
            "maxLength":"5",
            "type":"string",
            "description":"The access code of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the location of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCounty":{
            "maxLength":"60",
            "type":"string",
            "description":"The county of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyState":{
            "title":"State Name",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTrxId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the source transaction that created the case.",
            "nullable":true,
            "x-queryable":true
        },
        "ObsoleteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch to indicate that the case is obsolete.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PropertyCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "CriticalFlag":{
            "title":"Critical",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch to indicate that the case is critical.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "IntakeKey":{
            "type":"integer",
            "description":"The unique identifier of the intake.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Shape":{
            "type":"object",
            "description":"The shape of the property associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency of the case.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ComplianceDueDate":{
            "title":"Compliance Date",
            "type":"string",
            "description":"The compliance date of the case.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedId":{
            "title":"Inspector Assigned",
            "type":"integer",
            "description":"The unique identifier of the code officer assigned to the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyAddressId":{
            "type":"integer",
            "description":"The unique identifier of the property address of the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseCodeReference":{
            "title":"Code Violation",
            "type":"array",
            "description":"The code violation resource is used to view the code violation associated with a case.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCases-CaseCodeReference-item-response"
            }
        },
        "PropertyAddress2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "title":"Issue Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the issue.",
            "nullable":true,
            "x-queryable":true
        },
        "AppealDueDate":{
            "title":"Appeal By",
            "type":"string",
            "description":"The last date by which a user is allowed to submit an appeal for the case.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DistrictId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the district of the location of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueType":{
            "title":"Issue Type",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the issue type associated with the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "title":"Issue Subtype",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the issue subtype associated with the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The postal plus code of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportedById":{
            "title":"Reported By",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the person who reported the case.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue type of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyCountry":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyOwnerId":{
            "type":"integer",
            "description":"The unique identifier of the property owner of the case.",
            "nullable":true,
            "x-queryable":false
        },
        "ReviewerId":{
            "title":"Technician Assigned",
            "type":"integer",
            "description":"The unique identifier of the code technician assigned to the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The y-coordinate of the property address of the case.",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed On",
            "type":"string",
            "description":"The date when the case was closed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedBy":{
            "title":"Closed By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who closed the case.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The x-coordinate of the property address of the case.",
            "nullable":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
        }
    }
}

Nested Schema : Code Violation

Type: array

Title: Code Violation

The code violation resource is used to view the code violation associated with a case.

Show Source

• Array of: object publicSectorCases-CaseCodeReference-item-response

{
    "title":"Code Violation",
    "type":"array",
    "description":"The code violation resource is used to view the code violation associated with a case.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCases-CaseCodeReference-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 : Shape

Type: object

Read Only: true

The shape of the property associated with the case.

Nested Schema : publicSectorCases-CaseCodeReference-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1
• CaseId: string
  Read Only: true

  Maximum Length: 50
• CaseKey: integer (int64)
• CasePuid: string
  Maximum Length: 480

  Default Value:
• ChangeReasonCode: string
  Title: Reason for Update

  Default Value: ORA_ADMIN
• ChangeReasonText: string
  Title: Reason Details
• CodeReferenceCode: string
  Title: Code Violation

  Maximum Length: 100
• CodeReferenceDescription: string (byte)
• CodeReferenceKey: integer (int64)
• CodeReferenceName: string
  Maximum Length: 200
• CodeReferencePuid: string
  Maximum Length: 480
• Comments: string
  Title: Comments

  Maximum Length: 1000
• CompliedOn: string (date)
  Title: Complied On
• ComplyBy: string (date)
  Title: Comply By
• CorrectiveActionCode: string
  Maximum Length: 100
• CorrectiveActionDescription: string (byte)
• CorrectiveActionName: string
  Maximum Length: 200
• CreationDate: string (date-time)
  Read Only: true
• FeeFrequencyUnit: string
  Title: Frequency

  Maximum Length: 30

  Default Value: ORA_D
• FeeRate: number
  Title: Rate

  Default Value: 0
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceInspectionKey: integer (int64)
• SourceInspectionPuid: string
  Maximum Length: 480
• SourceTransactionContext: string
  Maximum Length: 80

  Default Value: ORA_MAN
• SourceTransactionContextKey: integer
• Status: string
  Title: Status

  Maximum Length: 8

  Default Value: ORA_OPEN
• StatusText: string
  Read Only: true

  Maximum Length: 255
• TotalFees: number
  Title: Total Fine

  Read Only: true
• TotalPaidFees: number
  Title: Total Fine Paid

  Read Only: true

{
    "type":"object",
    "properties":{
        "SourceInspectionPuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "StatusText":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CorrectiveActionName":{
            "maxLength":"200",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CodeReferencePuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "CompliedOn":{
            "title":"Complied On",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "CorrectiveActionDescription":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CodeReferenceName":{
            "maxLength":"200",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TotalPaidFees":{
            "title":"Total Fine Paid",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"8",
            "type":"string",
            "nullable":false,
            "default":"ORA_OPEN",
            "x-queryable":true
        },
        "SourceTransactionContextKey":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false
        },
        "CaseKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CodeReferenceCode":{
            "title":"Code Violation",
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "FeeRate":{
            "title":"Rate",
            "type":"number",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CaseId":{
            "maxLength":"50",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplyBy":{
            "title":"Comply By",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeFrequencyUnit":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "default":"ORA_D",
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Total Fine",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CorrectiveActionCode":{
            "maxLength":"100",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceInspectionKey":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeReasonCode":{
            "title":"Reason for Update",
            "type":"string",
            "nullable":true,
            "default":"ORA_ADMIN",
            "x-queryable":false
        },
        "CodeReferenceDescription":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceTransactionContext":{
            "maxLength":"80",
            "type":"string",
            "nullable":true,
            "default":"ORA_MAN",
            "x-queryable":false
        },
        "CodeReferenceKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeReasonText":{
            "title":"Reason Details",
            "type":"string",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

CaseCodeReference

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference

Parameters:

• CaseKey: $request.path.CaseKey

The code violation resource is used to view the code violation associated with a case.

Back to Top