Jump to

• Request
• Response

Get all incidents

get

/fscmRestApi/resources/11.13.18.05/publicSectorIncidentCommunications

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:
  
  

  • PrimaryKey: Finds an incident with a specified incident identifier.
    Finder Variables:
    • IncidentKey; integer; The unique identifier of the incident.
• 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:
  

  • AgencyFlag; string; Indicates whether an agency staff member reported the issue.
  • AgencyId; integer; The unique identifier for the agency.
  • AssignedCodeOfficerEmail; string; The email address of the code enforcement officer.
  • AssignedCodeOfficerName; string; The name of the code enforcement officer.
  • AssignedCodeOfficerPhone; string; The phone number of the code enforcement officer.
  • AssignedCodeTechnicianEmail; string; The email address of the code enforcement technician.
  • AssignedCodeTechnicianName; string; The name of the code enforcement technician.
  • AssignedCodeTechnicianPhone; string; The phone number of the code enforcement technician.
  • AssignedId; integer; The unique identifier for the code enforcement officer assigned to a particular case.
  • ClosedBy; string; The person ID of the person who closed the case.
  • ClosedDate; string; The date on which the incident was closed.
  • ClosedReason; string; The reason for closing the incident.
  • DisclosureFlag; string; Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private.
  • DistrictId; string; The unique identifier for the district of the incident location.
  • DistrictIdDescr; string; The description of the district where the issue is located.
  • DistrictType; string; The unique identifier for the district type that is associated with the issue subtype.
  • DistrictTypeDescr; string; The description of the district type that is associated with the issue subtype.
  • DuplicateFlag; string; Indicates whether the incident is a potential duplicate.
  • IncidentId; string; The unique identifier for the incident transaction.
  • IncidentKey; integer; The unique identifier for an incident. This number is created using autonumbering.
  • IntakeKey; integer; The unique identifier for an intake. This number is system generated.
  • IntakeSource; string; The transaction type for the transaction that is the source of an incident.
  • IssueDescription; string; Issue details for the reported incident.
  • IssueSubtype; string; The description of the issue subtype.
  • IssueSubtypeCode; string; The code for the issue subtype.
  • IssueSubtypeId; string; The unique identifier for the issue subtype.
  • IssueType; string; The description of the issue type.
  • IssueTypeId; string; The unique identifier for the issue type.
  • LocationDescr; string; Additional issue location information, such as an apartment number or descriptive details.
  • MigratedDataFlag; string; Identifies the migrated incident.
  • NotifyMeFlag; string; Indicates whether the registered user who reported the incident wishes to receive update notifications.
  • ObsoleteFlag; string; Indicates whether the issue is obsolete.
  • OriginatorSource; string; The identifier for the external source of the incident. Examples of values are 311, CRM, or CX.
  • ParcelIdEntered; string; The unique identifier for the parcel.
  • ParentId; string; The ID of the parent incident.
  • ParentType; string; The type of parent record, either an incident or a case.
  • PrimaryIssueFlag; string; Indicates whether the issue is the parent of another issue.
  • Priority; string; The incident priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.
  • PropertyAddress1; string; The first line of the property address for the reported incident.
  • PropertyAddress2; string; The second line of the property address for the reported incident.
  • PropertyAddress3; string; The third line of the property address for the reported incident.
  • PropertyAddress4; string; The fourth line of the property address for the reported incident.
  • PropertyCity; string; The city of the property address for the reported incident.
  • PropertyCountry; string; The country of the property address for the reported incident.
  • PropertyCounty; string; The county of the property address for the reported incident.
  • PropertyPostalCode; string; The postal code of the property address for the reported incident.
  • PropertyPostalPlusFourCode; string; The postal plus code of the property address for the reported incident.
  • PropertyProvince; string; The province of the property address for the reported incident.
  • PropertyState; string; The state of the property address for the reported incident.
  • ReferralCode; string; The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency.
  • ReferralType; string; The referral type for the issue. Referral types are used to identify the department, agency, or other group that an incident has been referred to.
  • ReporterEmail; string; The email address of the incident reporter.
  • ReporterName; string; The name of the incident reporter.
  • ReporterPhone; string; The phone number of the incident reporter.
  • ReviewDueDate; string; The review due date for the issue.
  • ReviewerId; integer; The unique identifier for the code enforcement technician who is the reviewer for a particular incident.
  • Status; string; The incident status.
  • StatusName; string; The description of the issue status.
  • SubmitDate; string; The submission date of the issue.
• 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 : publicSectorIncidentCommunications

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/publicSectorIncidentCommunications-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Communications",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorIncidentCommunications-item-response

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

Type: object

Show Source

• AgencyFlag: string
  Title: Reported by Agency

  Read Only: true

  Maximum Length: 1

  Indicates whether an agency staff member reported the issue.
• AgencyId: integer (int32)
  Read Only: true

  The unique identifier for the agency.
• AssignedCodeOfficerEmail: string
  Title: Code Officer Email

  Read Only: true

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

  Read Only: true

  The name of the code enforcement officer.
• AssignedCodeOfficerPhone: string
  Title: Code Officer Phone

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  The name of the code enforcement technician.
• AssignedCodeTechnicianPhone: string
  Title: Code Technician Phone

  Read Only: true

  The phone number of the code enforcement technician.
• AssignedId: integer (int64)
  Title: Code Officer

  Read Only: true

  The unique identifier for the code enforcement officer assigned to a particular case.
• ClosedBy: string
  Title: Closed By

  Read Only: true

  Maximum Length: 64

  The person ID of the person who closed the case.
• ClosedDate: string (date-time)
  Title: Closed Date

  Read Only: true

  The date on which the incident was closed.
• ClosedReason: string
  Title: Closed Reason

  Read Only: true

  Maximum Length: 450

  The reason for closing the incident.
• DisclosureFlag: string
  Title: Hide Reporter Contact Information

  Read Only: true

  Maximum Length: 1

  Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private.
• DistrictId: string
  Title: District ID

  Read Only: true

  Maximum Length: 30

  The unique identifier for the district of the incident location.
• DistrictIdDescr: string
  Title: District Description

  Read Only: true

  Maximum Length: 100

  The description of the district where the issue is located.
• DistrictType: string
  Title: District Type

  Read Only: true

  Maximum Length: 50

  The unique identifier for the district type that is associated with the issue subtype.
• DistrictTypeDescr: string
  Title: District Type Description

  Read Only: true

  Maximum Length: 100

  The description of the district type that is associated with the issue subtype.
• DuplicateFlag: string
  Title: Potential Duplicate

  Read Only: true

  Maximum Length: 1

  Indicates whether the incident is a potential duplicate.
• IncidentId: string
  Title: Incident ID

  Read Only: true

  Maximum Length: 50

  The unique identifier for the incident transaction.
• IncidentKey: integer (int64)
  Read Only: true

  The unique identifier for an incident. This number is created using autonumbering.
• IntakeKey: integer (int64)
  Read Only: true

  The unique identifier for an intake. This number is system generated.
• IntakeSource: string
  Title: Intake Source

  Read Only: true

  Maximum Length: 30

  The transaction type for the transaction that is the source of an incident.
• IssueDescription: string
  Title: Issue Description

  Read Only: true

  Maximum Length: 1000

  Issue details for the reported incident.
• IssueSubtype: string
  Title: Issue Subtype

  Read Only: true

  Maximum Length: 100

  The description of the issue subtype.
• IssueSubtypeCode: string
  Title: Issue Subtype ID

  Read Only: true

  Maximum Length: 40

  The code for the issue subtype.
• IssueSubtypeId: string
  Title: Issue Subtype Custom Id

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 100

  The description of the issue type.
• IssueTypeId: string
  Title: Issue Type ID

  Read Only: true

  Maximum Length: 50

  The unique identifier for the issue type.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 1000

  Additional issue location information, such as an apartment number or descriptive details.
• MigratedDataFlag: string
  Title: Migrated Incident

  Read Only: true

  Maximum Length: 3

  Identifies the migrated incident.
• NotifyMeFlag: string
  Title: Notify

  Read Only: true

  Maximum Length: 1

  Indicates whether the registered user who reported the incident wishes to receive update notifications.
• ObsoleteFlag: string
  Title: Obsolete

  Read Only: true

  Maximum Length: 1

  Indicates whether the issue is obsolete.
• OriginatorSource: string
  Title: Source of Incident

  Read Only: true

  Maximum Length: 30

  The identifier for the external source of the incident. Examples of values are 311, CRM, or CX.
• ParcelIdEntered: string
  Title: Parcel

  Read Only: true

  Maximum Length: 30

  The unique identifier for the parcel.
• ParentId: string
  Title: Parent ID

  Read Only: true

  Maximum Length: 50

  The ID of the parent incident.
• ParentType: string
  Title: Parent Type

  Read Only: true

  Maximum Length: 15

  The type of parent record, either an incident or a case.
• PrimaryIssueFlag: string
  Title: Primary Issue

  Read Only: true

  Maximum Length: 1

  Indicates whether the issue is the parent of another issue.
• Priority: string
  Title: Priority

  Read Only: true

  Maximum Length: 30

  The incident priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.
• PropertyAddress1: string
  Title: Address 1

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  The fourth line of the property address for the reported incident.
• PropertyCity: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the property address for the reported incident.
• PropertyCountry: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country of the property address for the reported incident.
• PropertyCounty: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county of the property address for the reported incident.
• PropertyPostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code of the property address for the reported incident.
• PropertyPostalPlusFourCode: string
  Title: Postal Plus Four Code

  Read Only: true

  Maximum Length: 10

  The postal plus code of the property address for the reported incident.
• PropertyProvince: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  The province of the property address for the reported incident.
• PropertyState: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state of the property address for the reported incident.
• ReferralCode: string
  Title: Referral Code

  Read Only: true

  Maximum Length: 100

  The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency.
• ReferralType: string
  Title: Type of Referral

  Read Only: true

  Maximum Length: 100

  The referral type for the issue. Referral types are used to identify the department, agency, or other group that an incident has been referred to.
• ReporterEmail: string
  Title: Reporter Email

  Read Only: true

  Maximum Length: 320

  The email address of the incident reporter.
• ReporterName: string
  Title: Reporter Name

  Read Only: true

  Maximum Length: 150

  The name of the incident reporter.
• ReporterPhone: string
  Title: Reporter Phone

  Read Only: true

  Maximum Length: 40

  The phone number of the incident reporter.
• ReviewDueDate: string (date-time)
  Title: Review Due Date

  Read Only: true

  The review due date for the issue.
• ReviewerId: integer (int64)
  Title: Code Technician

  Read Only: true

  The unique identifier for the code enforcement technician who is the reviewer for a particular incident.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 15

  The incident status.
• StatusName: string
  Title: Status Description

  Read Only: true

  Maximum Length: 30

  The description of the issue status.
• SubmitDate: string (date-time)
  Title: Submit Date

  Read Only: true

  The submission date of the issue.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "title":"Migrated Incident",
            "maxLength":"3",
            "type":"string",
            "description":"Identifies the migrated incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReporterPhone":{
            "title":"Reporter Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number of the incident reporter.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ReferralCode":{
            "title":"Referral Code",
            "maxLength":"100",
            "type":"string",
            "description":"The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submit Date",
            "type":"string",
            "description":"The submission date of the issue.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictTypeDescr":{
            "title":"District Type Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the district type that is associated with the issue subtype.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntakeSource":{
            "title":"Intake Source",
            "maxLength":"30",
            "type":"string",
            "description":"The transaction type for the transaction that is the source of an incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "title":"Issue Subtype Custom Id",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the issue subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedReason":{
            "title":"Closed Reason",
            "maxLength":"450",
            "type":"string",
            "description":"The reason for closing the incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyProvince":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentType":{
            "title":"Parent Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of parent record, either an incident or a case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the parcel.",
            "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"
            }
        },
        "AgencyFlag":{
            "title":"Reported by Agency",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an agency staff member reported the issue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"15",
            "type":"string",
            "description":"The incident status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictType":{
            "title":"District Type",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the district type that is associated with the issue subtype.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"The incident priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncidentKey":{
            "type":"integer",
            "description":"The unique identifier for an incident. This number is created using autonumbering.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginatorSource":{
            "title":"Source of Incident",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for the external source of the incident. Examples of values are 311, CRM, or CX.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationDescr":{
            "title":"Location Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Additional issue location information, such as an apartment number or descriptive details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Status Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the issue status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCounty":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyState":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotifyMeFlag":{
            "title":"Notify",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the registered user who reported the incident wishes to receive update notifications.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeTechnicianPhone":{
            "title":"Code Technician Phone",
            "type":"string",
            "description":"The phone number of the code enforcement technician.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"true",
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AssignedCodeOfficerEmail":{
            "title":"Code Officer Email",
            "type":"string",
            "description":"The email address of the code enforcement officer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"true",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObsoleteFlag":{
            "title":"Obsolete",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the issue is obsolete.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisclosureFlag":{
            "title":"Hide Reporter Contact Information",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeTechnicianName":{
            "title":"Code Technician Name",
            "type":"string",
            "description":"The name of the code enforcement technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntakeKey":{
            "type":"integer",
            "description":"The unique identifier for an intake. This number is system generated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ReferralType":{
            "title":"Type of Referral",
            "maxLength":"100",
            "type":"string",
            "description":"The referral type for the issue. Referral types are used to identify the department, agency, or other group that an incident has been referred to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReporterEmail":{
            "title":"Reporter Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the incident reporter.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AssignedId":{
            "title":"Code Officer",
            "type":"integer",
            "description":"The unique identifier for the code enforcement officer assigned to a particular case.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"true",
                "UserId":"Y",
                "precision":"18",
                "Recipient":"Y",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DistrictIdDescr":{
            "title":"District Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the district where the issue is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress2":{
            "title":"Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "title":"Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeTechnicianEmail":{
            "title":"Code Technician Email",
            "type":"string",
            "description":"The email address of the code enforcement technician.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"true",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "IssueSubtypeCode":{
            "title":"Issue Subtype ID",
            "maxLength":"40",
            "type":"string",
            "description":"The code for the issue subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "title":"Address 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeOfficerPhone":{
            "title":"Code Officer Phone",
            "type":"string",
            "description":"The phone number of the code enforcement officer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"true",
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PropertyAddress3":{
            "title":"Address 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentId":{
            "title":"Parent ID",
            "maxLength":"50",
            "type":"string",
            "description":"The ID of the parent incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReporterName":{
            "title":"Reporter Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the incident reporter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "title":"Issue Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Issue details for the reported incident.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictId":{
            "title":"District ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the district of the incident location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalPlusFourCode":{
            "title":"Postal Plus Four Code",
            "maxLength":"10",
            "type":"string",
            "description":"The postal plus code of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueType":{
            "title":"Issue Type",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the issue type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "title":"Issue Subtype",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the issue subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "title":"Issue Type ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the issue type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewDueDate":{
            "title":"Review Due Date",
            "type":"string",
            "description":"The review due date for the issue.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCountry":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country of the property address for the reported incident.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncidentId":{
            "title":"Incident ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the incident transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewerId":{
            "title":"Code Technician",
            "type":"integer",
            "description":"The unique identifier for the code enforcement technician who is the reviewer for a particular incident.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"true",
                "UserId":"Y",
                "precision":"18",
                "Recipient":"Y",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DuplicateFlag":{
            "title":"Potential Duplicate",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the incident is a potential duplicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryIssueFlag":{
            "title":"Primary Issue",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the issue is the parent of another issue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"The date on which the incident was closed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeOfficerName":{
            "title":"Code Officer Name",
            "type":"string",
            "description":"The name of the code enforcement officer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedBy":{
            "title":"Closed By",
            "maxLength":"64",
            "type":"string",
            "description":"The person ID of the person who closed the case.",
            "nullable":true,
            "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