Jump to

• Request
• Response

Get all case appeals

get

/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAppeals

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:
  
  

  • JobAttributeFilterOpenAppealsFinder: Finds the case appeal that matches the specified search criteria based on the job attributes of the logged in person..
    Finder Variables:
    • jobFunction; string; Finds the case appeal that matches the specified job function of the user.
    • personLoggedIn; integer; Finds the case appeal that matches the specified identifier of the logged in person.
  • OpenAppealsFinder: Finds the open case appeal that matches the specified search criteria.
    Finder Variables:
    • reviewerId; integer; The unique identifier of the code technician assigned to the case.
    • searchValue; string; Finds the open case appeal that matches the specified search value.
  • PrimaryKey: Finds the case appeal that matches the specified search criteria.
    Finder Variables:
    • CaseAppealKey; integer; The unique identifier of the case appeal.
  • ScheduledAppealsFinder: Finds the scheduled case appeal that matches the specified search criteria.
    Finder Variables:
    • endDate; string; The end of the date range to find scheduled appeals.
    • reviewerId; integer; The unique identifier of the code technician assigned to the case.
    • searchValue; string; Finds the scheduled appeals that match the specified search value.
    • startDate; string; The start of the date range to find scheduled appeals.
  • UnscheduledAppealsFinder: Finds the unscheduled case appeal that matches the specified search criteria.
    Finder Variables:
    • reviewerId; integer; The unique identifier of the code technician assigned to the case.
    • searchValue; string; Finds the unscheduled appeals that match the specified search value.
  • simpleSearchFinder: Finds the case appeal that matches the specified search criteria.
    Finder Variables:
    • searchValue; string; Finds the case appeals that match the specified search value.
  • simpleSearchJobAttributeFilterFinder: Finds the case notice that matches the specified search criteria and the job attributes of the logged in person.
    Finder Variables:
    • jobFunction; string; Finds the case notice that matches the specified search value and the job function.
    • personLoggedIn; integer; Finds the case notice that matches the specified search value and the identifier of the logged in person.
    • searchValue; string; Finds the case notice that matches the specified search value and the job attributes of the logged in person.
• 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:
  

  • AgencyId; integer; The unique identifier of the agency of the case.
  • AppealReason; string; The reason for the case appeal.
  • AppealSrc; string; The source of the appeal. Valid values are Hearings and Appeal.
  • AppealSrcCode; string; The source of the appeal. Valid values are Hearings and Appeal.
  • AppealStatus; string; The status of the case appeal.
  • AppealStatusName; string; The status of the case appeal.
  • AssignedCodeOfficerName; string; The assigned code officer for the case appeal.
  • AssignedCodeTechnicianName; string; The assigned code technician for the case appeal.
  • AssignedId; integer; The unique identifier of the code officer assigned to the case.
  • AttachmentCount; integer; The count of attachments for the case appeal.
  • CaseAppealKey; integer; The unique identifier of the case appeal.
  • CaseContactKey; integer; The unique identifier of the case contact.
  • CaseId; string; The unique identifier of the case.
  • CaseKey; integer; The unique identifier of the case.
  • CaseStatus; string; The status of the case.
  • ContactAddress1; string; The first line for the address of the appellant of the case.
  • ContactAddress2; string; The second line for the address of the address of the appellant of the case.
  • ContactAddress3; string; The third line for the address of the appellant of the case.
  • ContactAddress4; string; The fourth line for the address of the appellant of the case.
  • ContactCity; string; The city of the address of the appellant of the case.
  • ContactCountry; string; The country of the address of the appellant of the case.
  • ContactCounty; string; The county of the address of the appellant of the case.
  • ContactPersonFirstName; string; The first name of the appellant.
  • ContactPersonLastName; string; The last name of the appellant.
  • ContactPostalCode; string; The postal code of the address of the appellant of the case.
  • ContactPostalPlusCode; string; The postal plus code of the address of the appellant of the case.
  • ContactPrimaryFlag; boolean; The switch to indicate that the appellant is the primary contact of the case.
  • ContactProvince; string; The province of the address of the appellant of the case.
  • ContactState; string; The state of the address of the appellant of the case.
  • ContactType; string; The type of contact through which the appellant is associated with the case.
  • CreationDate; string; The date and time when the row was created.
  • DecisionDate; string; The hearing decision date for the case appeal.
  • HearingBodyCode; string; The unique identifier for the Hearing Body.
  • HearingDate; string; The hearing date for the case appeal.
  • HearingDecision; string; The hearing decision from the case appeal.
  • HrgBodyCode; string; The name of the hearing body.
  • HrgPurposeCode; string; The user defined purpose for the hearing related to the case appeal.
  • IssueSubtype; string; The name of the issue subtype associated with the case.
  • IssueSubtypeId; string; The unique identifier of the issue subtype of the case.
  • IssueTypeId; string; The unique identifier of the issue type of the case.
  • LastUpdateDate; string; The date and time when the row was last updated.
  • PropertyAddress1; string; The first line for the property address of the case.
  • PropertyAddress2; string; The second line for the property address of the case.
  • PropertyAddress3; string; The third line for the property address of the case.
  • PropertyAddress4; string; The fourth line for the property address of the case.
  • PropertyAddressId; integer; The unique identifier of the property address of the case.
  • PropertyCity; string; 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; The country of the property address of the case.
  • PropertyCounty; string; The county of the property address of the case.
  • PropertyParcelId; integer; The unique identifier of the property parcel of the case.
  • PropertyPostalCode; string; The postal code of the property address of the case.
  • PropertyPostalPlusFourCode; string; The postal plus code of the property address of the case.
  • PropertyProvince; string; The province of the property address of the case.
  • PropertyState; string; The state of the property address of the case.
  • RespContactKey; integer; The unique identifier of the responsible party for the hearing.
  • ResponsibleParty; string; The name of the responsible party of the hearing.
  • ReviewerId; integer; The unique identifier of the code technician assigned to the case.
• 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 : publicSectorListCaseAppeals

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/publicSectorListCaseAppeals-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 publicSectorListCaseAppeals-item-response

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

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The unique identifier of the agency of the case.
• AppealReason: string
  Title: Appeal Reason

  Read Only: true

  Maximum Length: 1000

  The reason for the case appeal.
• AppealSrc: string
  Read Only: true

  Maximum Length: 10

  Default Value: ORA_APL

  The source of the appeal. Valid values are Hearings and Appeal.
• AppealSrcCode: string
  Read Only: true

  Maximum Length: 255

  The source of the appeal. Valid values are Hearings and Appeal.
• AppealStatus: string
  Title: Hearing Status

  Read Only: true

  Maximum Length: 15

  Default Value: ORA_UNSHCD

  The status of the case appeal.
• AppealStatusName: string
  Read Only: true

  Maximum Length: 255

  The status of the case appeal.
• AssignedCodeOfficerName: string
  Title: Code Officer Name

  Read Only: true

  Maximum Length: 255

  The assigned code officer for the case appeal.
• AssignedCodeTechnicianName: string
  Title: Code Technician Name

  Read Only: true

  Maximum Length: 255

  The assigned code technician for the case appeal.
• AssignedId: integer (int64)
  Title: Inspector Assigned

  Read Only: true

  The unique identifier of the code officer assigned to the case.
• AttachmentCount: integer
  Read Only: true

  The count of attachments for the case appeal.
• CaseAppealKey: integer (int64)
  Read Only: true

  The unique identifier of the case appeal.
• CaseContactKey: integer (int64)
  Read Only: true

  The unique identifier of the case contact.
• CaseId: string
  Title: Case ID

  Read Only: true

  Maximum Length: 50

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

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

  Read Only: true

  Maximum Length: 15

  The status of the case.
• ContactAddress1: string
  Read Only: true

  Maximum Length: 240

  The first line for the address of the appellant of the case.
• ContactAddress2: string
  Read Only: true

  Maximum Length: 240

  The second line for the address of the address of the appellant of the case.
• ContactAddress3: string
  Read Only: true

  Maximum Length: 240

  The third line for the address of the appellant of the case.
• ContactAddress4: string
  Read Only: true

  Maximum Length: 240

  The fourth line for the address of the appellant of the case.
• ContactCity: string
  Read Only: true

  Maximum Length: 60

  The city of the address of the appellant of the case.
• ContactCountry: string
  Read Only: true

  Maximum Length: 3

  The country of the address of the appellant of the case.
• ContactCounty: string
  Read Only: true

  Maximum Length: 60

  The county of the address of the appellant of the case.
• ContactPersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 150

  The last name of the appellant.
• ContactPostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code of the address of the appellant of the case.
• ContactPostalPlusCode: string
  Read Only: true

  Maximum Length: 10

  The postal plus code of the address of the appellant of the case.
• ContactPrimaryFlag: boolean
  Title: Primary

  Read Only: true

  Maximum Length: 1

  Default Value: true

  The switch to indicate that the appellant is the primary contact of the case.
• ContactProvince: string
  Read Only: true

  Maximum Length: 60

  The province of the address of the appellant of the case.
• ContactState: string
  Read Only: true

  Maximum Length: 60

  The state of the address of the appellant of the case.
• ContactType: string
  Title: Type

  Read Only: true

  Maximum Length: 15

  Default Value: ORA_OWNER

  The type of contact through which the appellant is associated with 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

  Read Only: true

  The hearing decision date for the case appeal.
• Description: string (byte)
  Read Only: true

  The description of the issue subtype.
• HearingBodyCode: string
  Read Only: true

  Maximum Length: 60

  The unique identifier for the Hearing Body.
• HearingDate: string (date-time)
  Title: Hearing Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 15

  The hearing decision from the case appeal.
• HrgBodyCode: string
  Read Only: true

  Maximum Length: 255

  The name of the hearing body.
• HrgPurposeCode: string
  Read Only: true

  Maximum Length: 15

  The user defined purpose for the hearing related to the case appeal.
• IssueSubtype: string
  Read Only: true

  Maximum Length: 100

  The name of the issue subtype associated with the case.
• IssueSubtypeId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the issue subtype of the case.
• IssueTypeId: string
  Read Only: true

  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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PropertyAddress1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  The fourth line for the property address of the case.
• PropertyAddressId: integer (int64)
  Read Only: true

  The unique identifier of the property address of the case.
• PropertyCity: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the property address of the case.
• PropertyCoordinateX: number
  Read Only: true

  The x-coordinate of the property address of the case.
• PropertyCoordinateY: number
  Read Only: true

  The y-coordinate of the property address of the case.
• PropertyCountry: string
  Read Only: true

  Maximum Length: 3

  The country of the property address of the case.
• PropertyCounty: string
  Read Only: true

  Maximum Length: 60

  The county of the property address of the case.
• PropertyParcelId: integer (int64)
  Read Only: true

  The unique identifier of the property parcel of the case.
• PropertyPostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code of the property address of the case.
• PropertyPostalPlusFourCode: string
  Read Only: true

  Maximum Length: 10

  The postal plus code of the property address of the case.
• PropertyProvince: string
  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 60

  The state of the property address of the case.
• RespContactKey: integer (int64)
  Read Only: true

  The unique identifier of the responsible party for the hearing.
• ResponsibleParty: string
  Title: Responsible Party

  Read Only: true

  Maximum Length: 255

  The name of the responsible party of the hearing.
• ReviewerId: integer (int64)
  Title: Technician Assigned

  Read Only: true

  The unique identifier of the code technician assigned to the case.

{
    "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,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactCountry":{
            "maxLength":"3",
            "type":"string",
            "description":"The country of the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactType":{
            "title":"Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of contact through which the appellant is associated with the case.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_OWNER",
            "x-queryable":true
        },
        "ContactPersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the appellant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDate":{
            "title":"Hearing Date",
            "type":"string",
            "description":"The hearing date for the case appeal.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AppealStatusName":{
            "maxLength":"255",
            "type":"string",
            "description":"The status of the case appeal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RespContactKey":{
            "type":"integer",
            "description":"The unique identifier of the responsible party for the hearing.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"The province of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HrgBodyCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the hearing body.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HrgPurposeCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The user defined purpose for the hearing related to the case appeal.",
            "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"
            }
        },
        "ContactProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPostalPlusCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The postal plus code of the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyCounty":{
            "maxLength":"60",
            "type":"string",
            "description":"The county of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyState":{
            "title":"State Name",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseAppealKey":{
            "type":"integer",
            "description":"The unique identifier of the case appeal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ContactCounty":{
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppealReason":{
            "title":"Appeal Reason",
            "maxLength":"1000",
            "type":"string",
            "description":"The reason for the case appeal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AppealSrc":{
            "maxLength":"10",
            "type":"string",
            "description":"The source of the appeal. Valid values are Hearings and Appeal.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_APL",
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseStatus":{
            "title":"Appeal Type",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactState":{
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch to indicate that the appellant is the primary contact of the case.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "AssignedCodeTechnicianName":{
            "title":"Code Technician Name",
            "maxLength":"255",
            "type":"string",
            "description":"The assigned code technician for the case appeal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"The description of the issue subtype.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency of the case.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "HearingBodyCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the Hearing Body.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactAddress4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line for the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "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,
            "readOnly":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,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyAddress2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line for the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line for the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DecisionDate":{
            "title":"Decision Date",
            "type":"string",
            "description":"The hearing decision date for the case appeal.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactCity":{
            "maxLength":"60",
            "type":"string",
            "description":"The city of the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line for the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line for the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentCount":{
            "type":"integer",
            "description":"The count of attachments for the case appeal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The postal plus code of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the issue subtype associated with the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue type of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponsibleParty":{
            "title":"Responsible Party",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the responsible party of the hearing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCountry":{
            "maxLength":"3",
            "type":"string",
            "description":"The country of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseContactKey":{
            "type":"integer",
            "description":"The unique identifier of the case contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AppealSrcCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The source of the appeal. Valid values are Hearings and Appeal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppealStatus":{
            "title":"Hearing Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the case appeal.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_UNSHCD",
            "x-queryable":true
        },
        "ContactAddress2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line for the address of the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewerId":{
            "title":"Technician Assigned",
            "type":"integer",
            "description":"The unique identifier of the code technician assigned to the case.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactAddress3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line for the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactAddress1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line for the address of the appellant of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The y-coordinate of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeOfficerName":{
            "title":"Code Officer Name",
            "maxLength":"255",
            "type":"string",
            "description":"The assigned code officer for the case appeal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingDecision":{
            "title":"Hearing Decision",
            "maxLength":"15",
            "type":"string",
            "description":"The hearing decision from the case appeal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The x-coordinate of the property address of the case.",
            "nullable":true,
            "readOnly":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
        },
        "ContactPersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the appellant.",
            "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