Jump to

• Request
• Response

Get a case

get

/fscmRestApi/resources/11.13.18.05/publicSectorUserCases/{CaseKey}

Request

Path Parameters

• CaseKey: integer
  The unique identifier of the case.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Type: object

Show Source

• ActiveInspection(optional): string
  Maximum Length: 255

  A flag to indicate whether there is an active inspection for the case.
• AllowCaseAppeals(optional): array Allow Case Appeals
  Title: Allow Case Appeals

  The allow case appeal resource is used to view a case appeal allowance. Case appeals are used in code enforcement cases.
• AppealCreationDate(optional): string(date-time)
  Title: Appeal Requested On

  The date when an appeal for the case was submitted.
• AppealHearingDate(optional): string(date-time)
  Title: Hearing Scheduled For

  The date when the hearing for the appeal is scheduled.
• CaseId(optional): string
  Title: Case ID

  Maximum Length: 50

  The identifier of the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CitationCount(optional): integer(int32)
  The number of citations issued for the case.
• CodeOfficerDisplayName(optional): string
  Title: Code Officer

  Maximum Length: 255

  The name of the code officer assigned to the case.
• CodeOfficerPhoneNumber(optional): string
  Title: Code Officer Phone Number

  Maximum Length: 255

  The phone number of the code officer assigned to the case.
• ComplianceDueDate(optional): string(date)
  Title: Compliance Date

  The compliance date of the case.
• CurrencyCode(optional): string
  Maximum Length: 255

  The currency code associated with the fees for the case.
• EarliestDueAmount(optional): number
  The fee amount that is due on the earliest due date for the case.
• EarliestDueDate(optional): string(date)
  Title: Due On

  The earliest date for which fees are due for the case.
• HearingBody(optional): string
  The name of the hearing body that has scheduled the hearing.
• IssueDescription(optional): string
  Title: Issue Description

  Maximum Length: 1000

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

  Maximum Length: 100

  The name of the issue subtype associated with the case.
• IssueType(optional): string
  Title: Issue Type

  Maximum Length: 100

  The name of the issue type associated with the case.
• links(optional): array Items
  Title: Items

  Link Relations
• PropertyAddress1(optional): string
  Title: Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  The fourth line of the property address of the case.
• PropertyCity(optional): string
  Title: City

  Maximum Length: 60

  The city of the property address of the case.
• PropertyCountry(optional): string
  Maximum Length: 3

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

  The county of the property address of the case.
• PropertyPostalCode(optional): string
  Maximum Length: 60

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

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

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

  Maximum Length: 60

  The state of the property address of the case.
• Status(optional): string
  Title: Case Status

  Maximum Length: 15

  The status of the case.
• StatusName(optional): string
  Title: Status

  Maximum Length: 30

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

  The date when the case was submitted.
• TotalCaseFees(optional): number
  Title: Total Due

  Total fees to be paid for the case.
• TotalFeesPaid(optional): number
  Title: Total Paid

  Total fee amount that is paid for the case.
• TotalPaymentInProcess(optional): number
  Title: Payment in Progress

  Total fee amount for the case for which payment is in process.
• UserNotices(optional): array User Notices
  Title: User Notices

  The user notice resource is used to view a notice issued to a user. Notices can be issued for code enforcement violations or citations.

{
    "properties":{
        "ActiveInspection":{
            "maxLength":255,
            "type":"string",
            "description":"A flag to indicate whether there is an active inspection for the case."
        },
        "AllowCaseAppeals":{
            "items":{
                "$ref":"#/definitions/publicSectorUserCases-AllowCaseAppeals-item"
            },
            "type":"array",
            "description":"The allow case appeal resource is used to view a case appeal allowance. Case appeals are used in code enforcement cases.",
            "title":"Allow Case Appeals"
        },
        "AppealCreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when an appeal for the case was submitted.",
            "title":"Appeal Requested On"
        },
        "AppealHearingDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the hearing for the appeal is scheduled.",
            "title":"Hearing Scheduled For"
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the case.",
            "title":"Case ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CitationCount":{
            "format":"int32",
            "type":"integer",
            "description":"The number of citations issued for the case."
        },
        "CodeOfficerDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the code officer assigned to the case.",
            "title":"Code Officer"
        },
        "CodeOfficerPhoneNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The phone number of the code officer assigned to the case.",
            "title":"Code Officer Phone Number"
        },
        "ComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The compliance date of the case.",
            "title":"Compliance Date"
        },
        "CurrencyCode":{
            "maxLength":255,
            "type":"string",
            "description":"The currency code associated with the fees for the case."
        },
        "EarliestDueAmount":{
            "type":"number",
            "description":"The fee amount that is due on the earliest due date for the case."
        },
        "EarliestDueDate":{
            "format":"date",
            "type":"string",
            "description":"The earliest date for which fees are due for the case.",
            "title":"Due On"
        },
        "HearingBody":{
            "type":"string",
            "description":"The name of the hearing body that has scheduled the hearing."
        },
        "IssueDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the issue.",
            "title":"Issue Description"
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue subtype associated with the case.",
            "title":"Issue Subtype"
        },
        "IssueType":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue type associated with the case.",
            "title":"Issue Type"
        },
        "PropertyAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the property address of the case.",
            "title":"Address Line 1"
        },
        "PropertyAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the property address of the case.",
            "title":"Address Line 2"
        },
        "PropertyAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the property address of the case.",
            "title":"Address Line 3"
        },
        "PropertyAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the property address of the case.",
            "title":"Address Line 4"
        },
        "PropertyCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the property address of the case.",
            "title":"City"
        },
        "PropertyCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the property address of the case."
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the property address of the case."
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the property address of the case."
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the property address of the case."
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the property address of the case."
        },
        "PropertyState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the property address of the case.",
            "title":"State Name"
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case.",
            "title":"Case Status"
        },
        "StatusName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the status of the case.",
            "title":"Status"
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the case was submitted.",
            "title":"Submitted On"
        },
        "TotalCaseFees":{
            "type":"number",
            "description":"Total fees to be paid for the case.",
            "title":"Total Due"
        },
        "TotalFeesPaid":{
            "type":"number",
            "description":"Total fee amount that is paid for the case.",
            "title":"Total Paid"
        },
        "TotalPaymentInProcess":{
            "type":"number",
            "description":"Total fee amount for the case for which payment is in process.",
            "title":"Payment in Progress"
        },
        "UserNotices":{
            "items":{
                "$ref":"#/definitions/publicSectorUserCases-UserNotices-item"
            },
            "type":"array",
            "description":"The user notice resource is used to view a notice issued to a user. Notices can be issued for code enforcement violations or citations.",
            "title":"User Notices"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Allow Case Appeals

Type: array

Title: Allow Case Appeals

The allow case appeal resource is used to view a case appeal allowance. Case appeals are used in code enforcement cases.

Show Source

• Array of: object publicSectorUserCases-AllowCaseAppeals-item

{
    "items":{
        "$ref":"#/definitions/publicSectorUserCases-AllowCaseAppeals-item"
    },
    "type":"array",
    "description":"The allow case appeal resource is used to view a case appeal allowance. Case appeals are used in code enforcement cases.",
    "title":"Allow Case Appeals"
}

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 : User Notices

Type: array

Title: User Notices

The user notice resource is used to view a notice issued to a user. Notices can be issued for code enforcement violations or citations.

Show Source

• Array of: object publicSectorUserCases-UserNotices-item

{
    "items":{
        "$ref":"#/definitions/publicSectorUserCases-UserNotices-item"
    },
    "type":"array",
    "description":"The user notice resource is used to view a notice issued to a user. Notices can be issued for code enforcement violations or citations.",
    "title":"User Notices"
}

Nested Schema : publicSectorUserCases-AllowCaseAppeals-item

Type: object

Show Source

• AppealDueDate(optional): string(date)
  Title: Appeal By

  The last date by which a user can submit an appeal for the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• DenyReasonCode(optional): string
  The reason due to which appeal is not allowed for the case.
• IsAppealAllowed(optional): boolean
  Indicates whether appeal is allowed.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AppealDueDate":{
            "format":"date",
            "type":"string",
            "description":"The last date by which a user can submit an appeal for the case.",
            "title":"Appeal By"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "DenyReasonCode":{
            "type":"string",
            "description":"The reason due to which appeal is not allowed for the case."
        },
        "IsAppealAllowed":{
            "type":"boolean",
            "description":"Indicates whether appeal is allowed."
        },
        "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"
}

Nested Schema : publicSectorUserCases-UserNotices-item

Type: object

Show Source

• CaseKey(optional): integer(int64)
  The unique identifier of the case associated with the case notice.
• CaseNoticeId(optional): string
  Title: Notice ID

  Maximum Length: 50

  The identifier of the case notice.
• CaseNoticeKey(optional): integer(int64)
  The unique identifier of the case notice.
• GeneratedDate(optional): string(date-time)
  Title: Generated Date

  The date of generation of the case notice.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case associated with the case notice."
        },
        "CaseNoticeId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the case notice.",
            "title":"Notice ID"
        },
        "CaseNoticeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case notice."
        },
        "GeneratedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date of generation of the case notice.",
            "title":"Generated Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Back to Top