Jump to

• Request
• Response

Get a case

get

/fscmRestApi/resources/11.13.18.05/publicSectorCaseDetailsWithoutTransients/{CaseKey}

Request

Path Parameters

• CaseKey(required): integer
  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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorCaseDetailsWithoutTransients-item-response

Type: object

Show Source

• AccessCode: string
  Title: Access Number

  Read Only: true

  Maximum Length: 5

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

  Read Only: true

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

  Read Only: true

  The appeal due date for the case.
• AssignedCodeOfficerEmail: string
  Title: Code Officer Email

  Read Only: true

  Maximum Length: 240

  The email address of the code officer assigned to the case.
• AssignedCodeOfficerName: string
  Title: Code Officer Name

  Read Only: true

  Maximum Length: 240

  The name of the code officer assigned to the case.
• AssignedCodeOfficerPhone: string
  Title: Code Officer Phone Number

  Read Only: true

  Maximum Length: 60

  The phone number of the code officer assigned to the case.
• AssignedCodeTechnicianEmail: string
  Title: Code Technician Email

  Read Only: true

  Maximum Length: 240

  The email address of the code technician assigned to the case.
• AssignedCodeTechnicianName: string
  Title: Code Technician Name

  Read Only: true

  Maximum Length: 240

  The name of the code technician assigned to the case.
• AssignedCodeTechnicianPhone: string
  Title: Code Technician Phone

  Read Only: true

  Maximum Length: 60

  The phone number of the code technician assigned to the case.
• AssignedId: integer (int64)
  Title: Inspector Assigned

  Read Only: true

  The unique identifier of the code officer assigned to the case.
• CaseId: string
  Title: Case ID

  Read Only: true

  Maximum Length: 50

  The case identifier.
• CaseKey: integer
  Title: Case Key

  Read Only: true

  The unique identifier of the case.
• ChangeReason: string
  Title: Reason

  Read Only: true

  Maximum Length: 1000

  The reason for the case status change.
• ClosedBy: string
  Title: Closed By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 450

  The reason the case was closed.
• ComplianceDueDate: string (date)
  Title: Compliance Date

  Read Only: true

  The compliance date for the case.
• CompliedOn: string (date)
  Title: Complied On

  Read Only: true

  The date the case met all compliance requirements.
• 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 the row was created.
• CriticalFlag: boolean
  Title: Critical

  Read Only: true

  Maximum Length: 1

  Indicates whether the case is critical.
• DistrictDescription: string
  Read Only: true

  Maximum Length: 255

  The description of the case district.
• DistrictId: string
  Title: District ID

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 50

  The district type for the case location.
• DistrictTypeDescription: string
  Read Only: true

  Maximum Length: 255

  The description of the case district type.
• EarlyComplyByDate: string (date)
  Title: Earliest of Comply by Dates in Violations

  Read Only: true

  The earliest ???comply by??? date among open code violations for the case.
• FunctionalStatus: string
  Title: Transaction Status

  Read Only: true

  Maximum Length: 15

  The user-defined case status name that maps to a delivered system status.
• IntakeKey: integer (int64)
  Title: Intake Key

  Read Only: true

  The unique identifier of the intake.
• IntakeSource: string
  Title: Intake Source

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

  The internal priority of the case.
• IsReopened: string
  Read Only: true

  Maximum Length: 5

  Indicates whether the case is reopened.
• IssueDescription: string
  Title: Issue Description

  Read Only: true

  Maximum Length: 1000

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

  Read Only: true

  Maximum Length: 100

  The label for the issue subtype associated with the case.
• IssueSubtypeCode: string
  Read Only: true

  Maximum Length: 40

  The description of the case status.
• IssueSubtypeId: string
  Title: Issue Subtype ID

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 100

  The label for the issue type associated with the case.
• IssueTypeId: string
  Title: Issue Type ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the case issue type.
• LastComplyByDate: string (date)
  Title: Latest of Comply by Dates in Violations

  Read Only: true

  The latest ???comply by??? date among open code violations for the case.
• LastGisSyncDatetime: string (date-time)
  Title: GIS Last Synced

  Read Only: true

  The label for the field that displays the most recent date and time when applications (such as permits, planning applications, and business licenses) were synchronized to GIS mapping.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time 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
  Title: Latitude

  Read Only: true

  The latitude of the case location.
• LayoutVersion: string
  Read Only: true

  Maximum Length: 30

  The version of the case intake form layout.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 1000

  The description of the case location.
• Longitude: number
  Title: Longitude

  Read Only: true

  The longitude of the case location.
• MigratedDataFlag: string
  Title: Migrated Case

  Read Only: true

  Maximum Length: 3

  The migrated data identifier.
• ObsoleteFlag: boolean
  Title: Obsolete

  Read Only: true

  Maximum Length: 1

  Indicates whether the case is obsolete.
• ParcelIdEntered: string
  Title: Parcel Number

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 30

  The case priority.
• ProcessInconsistent: string
  Read Only: true

  Maximum Length: 10

  Indicates whether the case workflow is in an inconsistent state.
• ProcessInstanceId: string
  Title: Workflow Process ID

  Read Only: true

  Maximum Length: 500

  The workflow process instance identifier associated with the case.
• ProcessInstStatus: string
  Title: Workflow Process Status

  Read Only: true

  Maximum Length: 15

  The workflow process instance status associated with the case.
• PropertyAddress1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  The fourth address line of the case property address.
• PropertyAddressId: integer (int64)
  Title: Property Address ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 60

  The city in the case property address.
• PropertyCoordinateX: number
  Title: X Coordinate

  Read Only: true

  The x-coordinate of the case property address.
• PropertyCoordinateY: number
  Title: Y Coordinate

  Read Only: true

  The y-coordinate of the case property address.
• PropertyCountry: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country in the case property address.
• PropertyCounty: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county in the case property address.
• PropertyParcelId: integer (int64)
  Title: Parcel ID

  Read Only: true

  The unique identifier of the case property parcel.
• PropertyPostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the case property address.
• PropertyPostalPlusFourcode: string
  Title: Postal Plus 4 Code

  Read Only: true

  Maximum Length: 10

  The postal-plus code in the case property address.
• PropertyProvince: string
  Title: Province

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 60

  The state in the case property address.
• ReferralCode: string
  Title: Referral Code

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

  The unique identifier of the person who reported the case.
• ResponsiblePartyEmail: string
  Title: Responsible Party Email

  Read Only: true

  Maximum Length: 254

  The email address of the primary responsible party associated with the case.
• ResponsiblePartyName: string
  Title: Responsible Party

  Read Only: true

  Maximum Length: 301

  The name of the primary responsible party associated with the case.
• ResponsiblePartyPhone: string
  Title: Responsible Party Phone

  Read Only: true

  Maximum Length: 100

  The phone number of the primary responsible party associated with the case.
• ReviewerId: integer (int64)
  Title: Technician Assigned

  Read Only: true

  The unique identifier of the code technician assigned to the case.
• SourceTrxId: string
  Title: Source Transaction ID

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 15

  The case status.
• StatusDescription: string
  Title: Case Status

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  The date the case was submitted.
• TotalFeeDue: number
  Title: Total Due

  Read Only: true

  The total fees due for the case.
• TotalFees: number
  Title: Total Fees

  Read Only: true

  The total fees for the case.
• TotalPaid: number
  Title: Total Paid

  Read Only: true

  The total fees paid for the case.
• TotalPayableFees: number
  Title: Total Payable

  Read Only: true

  The total payable fees for the case.
• TotalPaymentInProcess: number
  Title: Total Payments in Process

  Read Only: true

  The total fees for the case with payment in progress.

{
    "type":"object",
    "properties":{
        "AccessCode":{
            "title":"Access Number",
            "maxLength":5,
            "type":"string",
            "description":"The access code used to claim the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the case.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AppealDueDate":{
            "title":"Appeal By",
            "type":"string",
            "description":"The appeal due date for the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeOfficerEmail":{
            "title":"Code Officer Email",
            "maxLength":240,
            "type":"string",
            "description":"The email address of the code officer assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AssignedCodeOfficerName":{
            "title":"Code Officer Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the code officer assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeOfficerPhone":{
            "title":"Code Officer Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the code officer assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AssignedCodeTechnicianEmail":{
            "title":"Code Technician Email",
            "maxLength":240,
            "type":"string",
            "description":"The email address of the code technician assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AssignedCodeTechnicianName":{
            "title":"Code Technician Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the code technician assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeTechnicianPhone":{
            "title":"Code Technician Phone",
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the code technician assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "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
        },
        "CaseId":{
            "title":"Case ID",
            "maxLength":50,
            "type":"string",
            "description":"The case identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "title":"Case Key",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeReason":{
            "title":"Reason",
            "maxLength":1000,
            "type":"string",
            "description":"The reason for the case status change.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedBy":{
            "title":"Closed By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who closed the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed On",
            "type":"string",
            "description":"The date the case was closed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedReason":{
            "title":"Reason for Closing",
            "maxLength":450,
            "type":"string",
            "description":"The reason the case was closed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplianceDueDate":{
            "title":"Compliance Date",
            "type":"string",
            "description":"The compliance date for the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompliedOn":{
            "title":"Complied On",
            "type":"string",
            "description":"The date the case met all compliance requirements.",
            "format":"date",
            "nullable":true,
            "readOnly":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-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriticalFlag":{
            "title":"Critical",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the case is critical.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictDescription":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the case district.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictId":{
            "title":"District ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the district for the case location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictType":{
            "title":"District Type",
            "maxLength":50,
            "type":"string",
            "description":"The district type for the case location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictTypeDescription":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the case district type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarlyComplyByDate":{
            "title":"Earliest of Comply by Dates in Violations",
            "type":"string",
            "description":"The earliest ???comply by??? date among open code violations for the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalStatus":{
            "title":"Transaction Status",
            "maxLength":15,
            "type":"string",
            "description":"The user-defined case status name that maps to a delivered system status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntakeKey":{
            "title":"Intake Key",
            "type":"integer",
            "description":"The unique identifier of the intake.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntakeSource":{
            "title":"Intake Source",
            "maxLength":30,
            "type":"string",
            "description":"The source of the case intake.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalPriority":{
            "title":"Internal Priority",
            "maxLength":30,
            "type":"string",
            "description":"The internal priority of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsReopened":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates whether the case is reopened.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "title":"Issue Description",
            "maxLength":1000,
            "type":"string",
            "description":"The issue description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "title":"Issue Subtype",
            "maxLength":100,
            "type":"string",
            "description":"The label for the issue subtype associated with the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeCode":{
            "maxLength":40,
            "type":"string",
            "description":"The description of the case status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "title":"Issue Subtype ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case issue subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueType":{
            "title":"Issue Type",
            "maxLength":100,
            "type":"string",
            "description":"The label for the issue type associated with the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "title":"Issue Type ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case issue type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastComplyByDate":{
            "title":"Latest of Comply by Dates in Violations",
            "type":"string",
            "description":"The latest ???comply by??? date among open code violations for the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastGisSyncDatetime":{
            "title":"GIS Last Synced",
            "type":"string",
            "description":"The label for the field that displays the most recent date and time when applications (such as permits, planning applications, and business licenses) were synchronized to GIS mapping.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude of the case location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LayoutVersion":{
            "maxLength":30,
            "type":"string",
            "description":"The version of the case intake form layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationDescription":{
            "title":"Location Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the case location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude of the case location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MigratedDataFlag":{
            "title":"Migrated Case",
            "maxLength":3,
            "type":"string",
            "description":"The migrated data identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObsoleteFlag":{
            "title":"Obsolete",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the case is obsolete.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel Number",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the parcel retrieved from the map for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"The case priority.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInconsistent":{
            "maxLength":10,
            "type":"string",
            "description":"Indicates whether the case workflow is in an inconsistent state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInstStatus":{
            "title":"Workflow Process Status",
            "maxLength":15,
            "type":"string",
            "description":"The workflow process instance status associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "title":"Workflow Process ID",
            "maxLength":500,
            "type":"string",
            "description":"The workflow process instance identifier associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address line of the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line of the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddressId":{
            "title":"Property Address ID",
            "type":"integer",
            "description":"The unique identifier of the case property address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PropertyCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-coordinate of the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-coordinate of the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCountry":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The unique identifier of the case property parcel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalPlusFourcode":{
            "title":"Postal Plus 4 Code",
            "maxLength":10,
            "type":"string",
            "description":"The postal-plus code in the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyProvince":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the case property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferralCode":{
            "title":"Referral Code",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the case referral body.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ResponsiblePartyEmail":{
            "title":"Responsible Party Email",
            "maxLength":254,
            "type":"string",
            "description":"The email address of the primary responsible party associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ResponsiblePartyName":{
            "title":"Responsible Party",
            "maxLength":301,
            "type":"string",
            "description":"The name of the primary responsible party associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponsiblePartyPhone":{
            "title":"Responsible Party Phone",
            "maxLength":100,
            "type":"string",
            "description":"The phone number of the primary responsible party associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "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
        },
        "SourceTrxId":{
            "title":"Source Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the source transaction that created the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The case status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDescription":{
            "title":"Case Status",
            "maxLength":30,
            "type":"string",
            "description":"The case status description.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submitted On",
            "type":"string",
            "description":"The date the case was submitted.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFeeDue":{
            "title":"Total Due",
            "type":"number",
            "description":"The total fees due for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Total Fees",
            "type":"number",
            "description":"The total fees for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Total Paid",
            "type":"number",
            "description":"The total fees paid for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPayableFees":{
            "title":"Total Payable",
            "type":"number",
            "description":"The total payable fees for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaymentInProcess":{
            "title":"Total Payments in Process",
            "type":"number",
            "description":"The total fees for the case with payment in progress.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top