Jump to

• Request
• Response

Get an incident

get

/fscmRestApi/resources/11.13.18.05/publicSectorIncidentCommunications/{publicSectorIncidentCommunicationsUniqID}

Request

Path Parameters

• publicSectorIncidentCommunicationsUniqID: string
  Identifier to Code Enforcement Incident Communications

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorIncidentCommunications-item

Type: object

Show Source

• AgencyFlag(optional): string
  Title: Reported by Agency

  Maximum Length: 1

  Indicates whether an agency staff member reported the issue.
• AgencyId(optional): integer(int32)
  The unique identifier for the agency.
• AssignedCodeOfficerEmail(optional): string
  Title: Code Officer Email

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

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

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

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

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

  The phone number of the code enforcement technician.
• ClosedBy(optional): string
  Title: Closed By

  Maximum Length: 64

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

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

  Maximum Length: 450

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

  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(optional): string
  Title: District ID

  Maximum Length: 30

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

  Maximum Length: 100

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

  Maximum Length: 50

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

  Maximum Length: 100

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

  Maximum Length: 1

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

  Maximum Length: 50

  The unique identifier for the incident transaction.
• IncidentKey(optional): integer(int64)
  The unique identifier for an incident. This number is created using autonumbering.
• IntakeSource(optional): string
  Title: Intake Source

  Maximum Length: 30

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

  Maximum Length: 1000

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

  Maximum Length: 100

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

  Maximum Length: 40

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

  Maximum Length: 50

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

  Maximum Length: 100

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

  Maximum Length: 50

  The unique identifier for the issue type.
• links(optional): array Items
  Title: Items

  Link Relations
• LocationDescr(optional): string
  Title: Location Description

  Maximum Length: 1000

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

  Maximum Length: 3

  Identifies the migrated incident.
• NotifyMeFlag(optional): string
  Title: Notify

  Maximum Length: 1

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

  Maximum Length: 1

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

  Maximum Length: 30

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

  Maximum Length: 30

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

  Maximum Length: 50

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

  Maximum Length: 15

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

  Maximum Length: 1

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

  Maximum Length: 30

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 60

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

  Maximum Length: 3

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

  Maximum Length: 60

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

  Maximum Length: 60

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

  Maximum Length: 10

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

  Maximum Length: 60

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

  Maximum Length: 60

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

  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(optional): string
  Title: Type of Referral

  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(optional): string
  Title: Reporter Email

  Maximum Length: 320

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

  Maximum Length: 150

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

  Maximum Length: 40

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

  The review due date for the issue.
• Status(optional): string
  Title: Status

  Maximum Length: 15

  The incident status.
• StatusName(optional): string
  Title: Status Description

  Maximum Length: 30

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

  The submission date of the issue.

{
    "properties":{
        "AgencyFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an agency staff member reported the issue.",
            "title":"Reported by Agency"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency."
        },
        "AssignedCodeOfficerEmail":{
            "type":"string",
            "description":"The email address of the code enforcement officer.",
            "title":"Code Officer Email"
        },
        "AssignedCodeOfficerName":{
            "type":"string",
            "description":"The name of the code enforcement officer.",
            "title":"Code Officer Name"
        },
        "AssignedCodeOfficerPhone":{
            "type":"string",
            "description":"The phone number of the code enforcement officer.",
            "title":"Code Officer Phone"
        },
        "AssignedCodeTechnicianEmail":{
            "type":"string",
            "description":"The email address of the code enforcement technician.",
            "title":"Code Technician Email"
        },
        "AssignedCodeTechnicianName":{
            "type":"string",
            "description":"The name of the code enforcement technician.",
            "title":"Code Technician Name"
        },
        "AssignedCodeTechnicianPhone":{
            "type":"string",
            "description":"The phone number of the code enforcement technician.",
            "title":"Code Technician Phone"
        },
        "ClosedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The person ID of the person who closed the case.",
            "title":"Closed By"
        },
        "ClosedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the incident was closed.",
            "title":"Closed Date"
        },
        "ClosedReason":{
            "maxLength":450,
            "type":"string",
            "description":"The reason for closing the incident.",
            "title":"Closed Reason"
        },
        "DisclosureFlag":{
            "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.",
            "title":"Hide Reporter Contact Information"
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the district of the incident location.",
            "title":"District ID"
        },
        "DistrictIdDescr":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the district where the issue is located.",
            "title":"District Description"
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the district type that is associated with the issue subtype.",
            "title":"District Type"
        },
        "DistrictTypeDescr":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the district type that is associated with the issue subtype.",
            "title":"District Type Description"
        },
        "DuplicateFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the incident is a potential duplicate.",
            "title":"Potential Duplicate"
        },
        "IncidentId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the incident transaction.",
            "title":"Incident ID"
        },
        "IncidentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for an incident. This number is created using autonumbering."
        },
        "IntakeSource":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type for the transaction that is the source of an incident.",
            "title":"Intake Source"
        },
        "IssueDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"Issue details for the reported incident.",
            "title":"Issue Description"
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the issue subtype.",
            "title":"Issue Subtype"
        },
        "IssueSubtypeCode":{
            "maxLength":40,
            "type":"string",
            "description":"The code for the issue subtype.",
            "title":"Issue Subtype ID"
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the issue subtype.",
            "title":"Issue Subtype Custom Id"
        },
        "IssueType":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the issue type.",
            "title":"Issue Type"
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the issue type.",
            "title":"Issue Type ID"
        },
        "LocationDescr":{
            "maxLength":1000,
            "type":"string",
            "description":"Additional issue location information, such as an apartment number or descriptive details.",
            "title":"Location Description"
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Identifies the migrated incident.",
            "title":"Migrated Incident"
        },
        "NotifyMeFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the registered user who reported the incident wishes to receive update notifications.",
            "title":"Notify"
        },
        "ObsoleteFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the issue is obsolete.",
            "title":"Obsolete"
        },
        "OriginatorSource":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier for the external source of the incident. Examples of values are 311, CRM, or CX.",
            "title":"Source of Incident"
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the parcel.",
            "title":"Parcel"
        },
        "ParentId":{
            "maxLength":50,
            "type":"string",
            "description":"The ID of the parent incident.",
            "title":"Parent ID"
        },
        "ParentType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of parent record, either an incident or a case.",
            "title":"Parent Type"
        },
        "PrimaryIssueFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the issue is the parent of another issue.",
            "title":"Primary Issue"
        },
        "Priority":{
            "maxLength":30,
            "type":"string",
            "description":"The incident priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.",
            "title":"Priority"
        },
        "PropertyAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the property address for the reported incident.",
            "title":"Address 1"
        },
        "PropertyAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the property address for the reported incident.",
            "title":"Address 2"
        },
        "PropertyAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the property address for the reported incident.",
            "title":"Address 3"
        },
        "PropertyAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the property address for the reported incident.",
            "title":"Address 4"
        },
        "PropertyCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the property address for the reported incident.",
            "title":"City"
        },
        "PropertyCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the property address for the reported incident.",
            "title":"Country"
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the property address for the reported incident.",
            "title":"County"
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the property address for the reported incident.",
            "title":"Postal Code"
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the property address for the reported incident.",
            "title":"Postal Plus Four Code"
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the property address for the reported incident.",
            "title":"Province"
        },
        "PropertyState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the property address for the reported incident.",
            "title":"State"
        },
        "ReferralCode":{
            "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.",
            "title":"Referral Code"
        },
        "ReferralType":{
            "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.",
            "title":"Type of Referral"
        },
        "ReporterEmail":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the incident reporter.",
            "title":"Reporter Email"
        },
        "ReporterName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the incident reporter.",
            "title":"Reporter Name"
        },
        "ReporterPhone":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the incident reporter.",
            "title":"Reporter Phone"
        },
        "ReviewDueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The review due date for the issue.",
            "title":"Review Due Date"
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The incident status.",
            "title":"Status"
        },
        "StatusName":{
            "maxLength":30,
            "type":"string",
            "description":"The description of the issue status.",
            "title":"Status Description"
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The submission date of the issue.",
            "title":"Submit Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top