Jump to

• Request
• Response

Get all case appeals

get

/fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • CaseAppealPuidKey: Finds the case appeal that matches the specified alternate key.
    Finder Variables:
    • CaseAppealPuid; string; The public unique identifier of the migrated case appeal record.
  • PrimaryKey: Finds the case appeal that matches the specified search criteria.
    Finder Variables:
    • CaseAppealKey; integer; The unique identifier of the case appeal.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AppealReason; string; The reason for the case appeal.
  • AppealSrc; string; The source of the transaction such as Appeal or Hearing.
  • AppealStatus; string; The status of the case appeal.
  • CaseAppealKey; integer; The unique identifier of the case appeal.
  • CaseAppealPuid; string; The public unique identifier of the migrated case appeal record.
  • CaseCompliedOn; string; The date on which the case met all requirements for compliance.
  • CaseContactKey; integer; The unique identifier of the case contact.
  • CaseContactPuid; string; The public unique identifier of the migrated case contact record.
  • CaseKey; integer; The unique identifier of the case.
  • CasePuid; string; The public unique identifier of the migrated case record.
  • CaseStatus; string; The status of the case.
  • Comments; string; The comments for the case appeal.
  • ComplianceDueDate; string; The compliance date of the case.
  • CreationDate; string; The date and time when the row was created.
  • DecisionDate; string; The hearing decision date for the case appeal.
  • EventDecision; string; The system defined status of the hearing decision.
  • GenCitFlag; string; Identifies if a citation should be issued.
  • GenVioFlag; string; Identifies if a notice of violation should be issued.
  • HearingDate; string; The hearing date for the case appeal.
  • HearingDecision; string; The hearing decision from the case appeal.
  • HrgBodyCode; string; The identifier of the hearing body configured in the system.
  • HrgDecisionCode; string; The user defined status of the hearing decision.
  • HrgPurposeCode; string; The user defined purpose for the hearing related to the case appeal.
  • LastUpdateDate; string; The date and time when the row was last updated.
  • LastUpdatedByName; string; The name of the user who last updated the row.
  • PersonFirstName; string; The first name of the appellant.
  • PersonLastName; string; The last name of the appellant.
  • RespContactKey; integer; The identifier of the person responsible for the appeal or hearing that is being processed.
  • UpdateCodeReferenceFlag; string; Identifies if a code violation should be updated.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCaseAppeals-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"CodeEnforcement",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorCaseAppeals-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCaseAppeals-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 : publicSectorCaseAppeals-item-response

Type: object

Show Source

• AppealReason: string
  Title: Appeal Reason

  Maximum Length: 1000

  The reason for the case appeal.
• AppealSrc: string
  Maximum Length: 10

  Default Value: ORA_APL

  The source of the transaction such as Appeal or Hearing.
• AppealStatus: string
  Title: Hearing Status

  Maximum Length: 15

  Default Value: ORA_UNSHCD

  The status of the case appeal.
• CaseAppealKey: integer (int64)
  The unique identifier of the case appeal.
• CaseAppealPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case appeal record.
• CaseComplianceDueDate: string
  Title: New Compliance Due Date

  The case compliance due date.
• CaseCompliedOn: string (date)
  The date on which the case met all requirements for compliance.
• CaseContactKey: integer (int64)
  The unique identifier of the case contact.
• CaseContactPuid: string
  The public unique identifier of the migrated case contact record.
• CaseFunctionalStatus: string
  Title: Case Status

  The user defined case status name that maps to a delivered system status.
• CaseKey: integer (int64)
  The unique identifier of the case.
• CasePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• CaseStatus: string
  Title: Appeal Type

  Maximum Length: 15

  The status of the case.
• CitationDueDate: string (date)
  Title: New Citation Due Date

  The citation due date.
• Comments: string
  Title: Comments

  Maximum Length: 1000

  The comments for the case appeal.
• ComplianceDueDate: string (date)
  Read Only: true

  The compliance date of the case.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• DecisionDate: string (date-time)
  Title: Decision Date

  The hearing decision date for the case appeal.
• EventDecision: string
  Read Only: true

  Maximum Length: 15

  The system defined status of the hearing decision.
• GenCitFlag: string
  Maximum Length: 1

  Default Value: N

  Identifies if a citation should be issued.
• GenVioFlag: string
  Maximum Length: 1

  Default Value: N

  Identifies if a notice of violation should be issued.
• HearingDate: string (date-time)
  Title: Hearing Date

  The hearing date for the case appeal.
• HearingDecision: string
  Title: Hearing Decision

  Maximum Length: 15

  The hearing decision from the case appeal.
• HrgBodyCode: string
  Maximum Length: 60

  The identifier of the hearing body configured in the system.
• HrgDecisionCode: string
  Maximum Length: 15

  The user defined status of the hearing decision.
• HrgPurposeCode: string
  Maximum Length: 15

  The user defined purpose for the hearing related to the case appeal.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

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

  Read Only: true

  Maximum Length: 150

  The first name of the appellant.
• PersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the appellant.
• RespContactKey: integer (int64)
  The identifier of the person responsible for the appeal or hearing that is being processed.
• UpdateCodeReferenceFlag: string
  Maximum Length: 1

  Default Value: N

  Identifies if a code violation should be updated.

{
    "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
        },
        "CitationDueDate":{
            "title":"New Citation Due Date",
            "type":"string",
            "description":"The citation due date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "HrgDecisionCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The user defined status of the hearing decision.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplianceDueDate":{
            "type":"string",
            "description":"The compliance date of the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "x-queryable":true
        },
        "HearingDate":{
            "title":"Hearing Date",
            "type":"string",
            "description":"The hearing date for the case appeal.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CaseFunctionalStatus":{
            "title":"Case Status",
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RespContactKey":{
            "type":"integer",
            "description":"The identifier of the person responsible for the appeal or hearing that is being processed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HrgBodyCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The identifier of the hearing body configured in the system.",
            "nullable":true,
            "x-queryable":true
        },
        "HrgPurposeCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The user defined purpose for the hearing related to the case appeal.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DecisionDate":{
            "title":"Decision Date",
            "type":"string",
            "description":"The hearing decision date for the case appeal.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenCitFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Identifies if a citation should be issued.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "CaseCompliedOn":{
            "type":"string",
            "description":"The date on which the case met all requirements for compliance.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the appellant.",
            "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
        },
        "EventDecision":{
            "maxLength":"15",
            "type":"string",
            "description":"The system defined status of the hearing decision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The comments for the case appeal.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the appellant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseContactKey":{
            "type":"integer",
            "description":"The unique identifier of the case contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseAppealKey":{
            "type":"integer",
            "description":"The unique identifier of the case appeal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CaseContactPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated case contact record.",
            "nullable":true,
            "x-queryable":true
        },
        "AppealStatus":{
            "title":"Hearing Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the case appeal.",
            "nullable":false,
            "default":"ORA_UNSHCD",
            "x-queryable":true
        },
        "AppealReason":{
            "title":"Appeal Reason",
            "maxLength":"1000",
            "type":"string",
            "description":"The reason for the case appeal.",
            "nullable":false,
            "x-queryable":true
        },
        "AppealSrc":{
            "maxLength":"10",
            "type":"string",
            "description":"The source of the transaction such as Appeal or Hearing.",
            "nullable":false,
            "default":"ORA_APL",
            "x-queryable":true
        },
        "CaseComplianceDueDate":{
            "title":"New Compliance Due Date",
            "type":"string",
            "description":"The case compliance due date.",
            "nullable":true,
            "x-queryable":false
        },
        "CaseStatus":{
            "title":"Appeal Type",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "CaseAppealPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated case appeal record.",
            "nullable":false,
            "x-queryable":true
        },
        "GenVioFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Identifies if a notice of violation should be issued.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "UpdateCodeReferenceFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Identifies if a code violation should be updated.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "HearingDecision":{
            "title":"Hearing Decision",
            "maxLength":"15",
            "type":"string",
            "description":"The hearing decision from the case appeal.",
            "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 : 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."
        }
    }
}

Back to Top