Create an intake
post
/fscmRestApi/resources/11.13.18.05/publicSectorIntakes
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorIntakes-item
Type:
objectDiscriminator:
Show Source
RowType-
AgencyFlag(optional):
boolean
The identifier that indicates whether the row is created by an agency user.
-
AnonymousFlag(optional):
boolean
The identifier that indicates whether the issue is created by a guest user.
-
AttXrefTransKey(optional):
integer(int64)
The cross reference key for an attachment associated with the intake.
-
Case(optional):
array Cases
Title:
CasesThe intakes resource is used to view, create, delete, or modify code enforcement incidents and cases. -
ComplnAddress1(optional):
string
Maximum Length:
240The first line of the complainant address. -
ComplnAddress2(optional):
string
Maximum Length:
240The second line of the complainant address. -
ComplnAddress3(optional):
string
Maximum Length:
240The third line of the complainant address. -
ComplnAddress4(optional):
string
Maximum Length:
240The fourth line of the complainant address. -
ComplnCity(optional):
string
Maximum Length:
60The complainant city. -
ComplnCountry(optional):
string
Maximum Length:
3The complainant country. -
ComplnCounty(optional):
string
Maximum Length:
60The complainant county. -
ComplnPostalCode(optional):
string
Maximum Length:
60The complainant postal code. -
ComplnPostalPlusFourCode(optional):
string
Maximum Length:
10The complainant postal plus code. -
ComplnProvince(optional):
string
Maximum Length:
60The complainant province. -
ComplnState(optional):
string
Maximum Length:
60The complainant state. -
CompnEmail(optional):
string
Maximum Length:
320The complainant email. -
CompnFirstName(optional):
string
Maximum Length:
150The first name of the complainant. -
CompnLastName(optional):
string
Maximum Length:
150The last name of the complainant. -
CompnMiddleName(optional):
string
Maximum Length:
60The complainant middle name. -
CompnName(optional):
string
Maximum Length:
450The complainant name. -
CompnNameSuffix(optional):
string
Maximum Length:
30The name suffix of the complainant. -
CompnPhoneAreaCode(optional):
string
Maximum Length:
10The complainant phone area code. -
CompnPhoneCountryCode(optional):
string
Maximum Length:
10The complainant phone country code. -
CompnPhoneExtension(optional):
string
Maximum Length:
20The complainant phone extension. -
CompnPhoneNumber(optional):
string
Maximum Length:
40The complainant phone number. -
CompnTitle(optional):
string
Maximum Length:
60The title of the complainant. -
CreatedBy(optional):
string
Maximum Length:
64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
The date and time when the row was created.
-
DisclosureFlag(optional):
boolean
The identifier that indicates whether to disclose the details of an intake.
-
Incident(optional):
array Incidents
Title:
IncidentsThe intakes resource is used to view, create, delete, or modify code enforcement incidents and cases. -
IntakeId(optional):
string
Maximum Length:
50The unique identifier for an intake. -
IntakeKey(optional):
integer(int64)
An identifier for an intake that is created using autonumbering.
-
IntakeSource(optional):
string
Maximum Length:
30The source of the intake transaction. -
IntakeType(optional):
string
Maximum Length:
30The intake type. -
IssueDescription(optional):
string
Maximum Length:
1000The description of the issue or problem. -
IssueSubtypeId(optional):
string
Maximum Length:
50The unique identifier of the issue subtype. -
IssueTypeId(optional):
string
Maximum Length:
50The unique identifier of the issue type. -
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The name of the user who last updated the row. -
Latitude(optional):
number
The latitude of the property address for the complaint.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationDescr(optional):
string
Maximum Length:
1000The text description of the location of the complaint. -
Longitude(optional):
number
The longitude of the property address for the complaint.
-
NotifyMeFlag(optional):
boolean
The identifier that indicates whether to notify the user.
-
OriginatorSource(optional):
string
Maximum Length:
30The originator source. -
OriginatorSrId(optional):
string
Maximum Length:
30The originator spatial reference ID. -
ParcelIdEntered(optional):
string
Maximum Length:
30The parcel ID selected by the complainant. -
Priority(optional):
string
Maximum Length:
30The priority of the intake. -
PropertyAddress1(optional):
string
Maximum Length:
240The first line of the property address for the complaint. -
PropertyAddress2(optional):
string
Maximum Length:
240The second line of the property address for the complaint. -
PropertyAddress3(optional):
string
Maximum Length:
240The third line of the property address for the complaint. -
PropertyAddress4(optional):
string
Maximum Length:
240The fourth line of the property address for the complaint. -
PropertyCity(optional):
string
Maximum Length:
60The city of the property address for the complaint. -
PropertyCoordinateX(optional):
number
The x-coordinate of the property address for the complaint.
-
PropertyCoordinateY(optional):
number
The y-coordinate of the property address for the complaint.
-
PropertyCountry(optional):
string
Maximum Length:
3The country of the property address for the complaint. -
PropertyCounty(optional):
string
Maximum Length:
60The county of the property address for the complaint. -
PropertyPostalCode(optional):
string
Maximum Length:
60The postal code of the property address for the complaint. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10The postal plus code of the property address for the complaint. -
PropertyProvince(optional):
string
Maximum Length:
60The province of the property address for the complaint. -
PropertyState(optional):
string
Maximum Length:
60The state of the property address for the complaint. -
RecordName(optional):
string
Maximum Length:
80The record name of an intake row. -
RecordNumber(optional):
string
Maximum Length:
64The record number of an intake row. -
ReportedById(optional):
string
Maximum Length:
18The reported person ID. -
RowType:
string
Maximum Length:
30The row type of an intake. -
Severity(optional):
string
Maximum Length:
4The severity indicator. -
Srid(optional):
integer(int64)
The spatial reference ID.
-
Status(optional):
string
Maximum Length:
15The status of an intake. -
SubmitDate(optional):
string(date-time)
The date when the intake is submitted.
Nested Schema : Cases
Type:
arrayTitle:
CasesThe intakes resource is used to view, create, delete, or modify code enforcement incidents and cases.
Show Source
Nested Schema : Incidents
Type:
arrayTitle:
IncidentsThe intakes resource is used to view, create, delete, or modify code enforcement incidents and cases.
Show Source
Nested Schema : publicSectorIntakes-Case-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the agency of the case. -
AssignedId(optional):
integer(int64)
Title:
Inspector AssignedThe unique identifier of the code officer assigned to the case. -
CaseCodeReference(optional):
array Case Code References
Title:
Case Code ReferencesThe cases resource is used to view, create, delete, or modify code enforcement cases. -
CaseId(optional):
string
Title:
Case IDMaximum Length:50The identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
ChangeReason(optional):
string
The reason for modifying the case.
-
ClosedBy(optional):
string
Title:
Closed ByMaximum Length:64The name of the user who closed the case. -
ClosedDate(optional):
string(date-time)
Title:
Closed OnThe date when the case was closed. -
ClosedReason(optional):
string
Title:
Reason for ClosingMaximum Length:450The reason for closing the case. -
ComplianceDueDate(optional):
string(date)
Title:
Compliance DateThe compliance date of the case. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the row was created. -
CriticalFlag(optional):
boolean
Title:
CriticalThe switch to indicate that the case is critical. -
DistrictId(optional):
string
Maximum Length:
30The type of district ID associated with the case. -
DistrictType(optional):
string
Title:
District TypeMaximum Length:50The type of district associated with the case. -
IntakeKey(optional):
integer(int64)
The unique identifier of the intake.
-
IntakeSource(optional):
string
Maximum Length:
30The source of the case intake. -
InternalPriority(optional):
string
Title:
Internal PriorityMaximum Length:30The internal priority of the case. -
IssueDescription(optional):
string
Title:
Issue DescriptionMaximum Length:1000The description of the issue. -
IssueSubtype(optional):
string
Maximum Length:
100The name of the issue subtype associated with the case. -
IssueSubtypeId(optional):
string
Maximum Length:
50The unique identifier of the issue subtype of the case. -
IssueType(optional):
string
Maximum Length:
100The name of the issue type associated with the case. -
IssueTypeId(optional):
string
Maximum Length:
50The unique identifier of the issue type of the case. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the row. -
Latitude(optional):
number
The latitude of the location of the case.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationDescription(optional):
string
Title:
Location DescriptionMaximum Length:1000The description of the location. -
Longitude(optional):
number
The longitude of the location of the case.
-
ObsoleteFlag(optional):
boolean
The switch to indicate that the case is obsolete.
-
Priority(optional):
string
Title:
PriorityMaximum Length:30The priority of the case. -
PropertyAddress1(optional):
string
Title:
Address Line 1Maximum Length:240The first line of the property address of the case. -
PropertyAddress2(optional):
string
Title:
Address Line 2Maximum Length:240The second line of the property address of the case. -
PropertyAddress3(optional):
string
Title:
Address Line 3Maximum Length:240The third line of the property address of the case. -
PropertyAddress4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth line of the property address of the case. -
PropertyAddressId(optional):
integer(int64)
The unique identifier of the property address of the case.
-
PropertyCity(optional):
string
Title:
CityMaximum Length:60The city of the property address of the case. -
PropertyCoordinateX(optional):
number
The x-coordinate of the property address of the case.
-
PropertyCoordinateY(optional):
number
The y-coordinate of the property address of the case.
-
PropertyCountry(optional):
string
Maximum Length:
3The country of the property address of the case. -
PropertyCounty(optional):
string
Maximum Length:
60The county of the property address of the case. -
PropertyParcelId(optional):
integer(int64)
The unique identifier of the property parcel of the case.
-
PropertyPostalCode(optional):
string
Maximum Length:
60The postal code of the property address of the case. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10The postal plus code of the property address of the case. -
PropertyProvince(optional):
string
Maximum Length:
60The province of the property address of the case. -
PropertyState(optional):
string
Title:
State NameMaximum Length:60The state of the property address of the case. -
ReferralCode(optional):
string
Title:
Referred ToMaximum Length:100The unique identifier of the referral body of the case. -
ReportedById(optional):
string
Title:
Reported ByMaximum Length:64The unique identifier of the person who reported the case. -
ReviewerId(optional):
integer(int64)
Title:
Technician AssignedThe unique identifier of the code technician assigned to the case. -
SourceTrxId(optional):
string
Maximum Length:
50The unique identifier of the source transaction that created the case. -
Status(optional):
string
Title:
Case StatusMaximum Length:15The status of the case. -
SubmitDate(optional):
string(date-time)
Title:
Submitted OnThe date when the case was submitted.
Nested Schema : Case Code References
Type:
arrayTitle:
Case Code ReferencesThe cases resource is used to view, create, delete, or modify code enforcement cases.
Show Source
Nested Schema : publicSectorIntakes-Case-CaseCodeReference-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The agency identifier of the case code reference.
-
CaseId(optional):
string
Maximum Length:
50The identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CodeReferenceCode(optional):
string
Maximum Length:
100The identifier of the violation code reference. -
CodeReferenceKey(optional):
integer(int64)
The unique identifier of the case code reference.
-
CreatedBy(optional):
string
Maximum Length:
64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
The date and time when the row was created.
-
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The name of the user who last updated the row. -
links(optional):
array Items
Title:
ItemsLink Relations
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorIntakes-Incident-item
Type:
Show Source
object-
AgencyFlag(optional):
boolean
Indicates whether an agency staff member reported the issue.
-
AgencyId(optional):
integer(int32)
The unique agency ID.
-
AssignedId(optional):
integer(int64)
The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.
-
ClosedBy(optional):
string
Maximum Length:
64The person ID of the person who closed the case. -
ClosedDate(optional):
string(date-time)
The incident close date.
-
ClosedReason(optional):
string
Maximum Length:
450The reason for closing the incident. -
DisclosureFlag(optional):
boolean
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
Maximum Length:
30The unique identifier for the district of the incident location. -
DistrictType(optional):
string
Maximum Length:
50The district type for the transaction that is the source of an incident. -
DuplicateFlag(optional):
string
Maximum Length:
1Indicates whether the incident is a potential duplicate. -
IncidentId(optional):
string
Maximum Length:
50A logical ID for the incident transaction. -
IncidentKey(optional):
integer(int64)
The unique identifier for an incident. This number is created using autonumbering.
-
IntakeKey(optional):
integer(int64)
The key from the intake record. The intake record is the parent of the incident record.
-
IntakeSource(optional):
string
Maximum Length:
30The transaction type for the transaction that is the source of an incident. -
IssueDescription(optional):
string
Maximum Length:
1000The complainant's issue description. -
IssueSubtype(optional):
string
Maximum Length:
100The description of the issue subtype. -
IssueSubtypeCode(optional):
string
Maximum Length:
40The code for the issue subtype. -
IssueSubtypeId(optional):
string
Maximum Length:
50The logical issue subtype ID. -
IssueType(optional):
string
Maximum Length:
100The description of the issue type. -
IssueTypeId(optional):
string
Maximum Length:
50The logical issue type ID. -
Latitude(optional):
number
The latitude of the property that is associated with the issue.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationDescr(optional):
string
Maximum Length:
1000Additional issue location information such as an apartment number or descriptive details. -
Longitude(optional):
number
The longitude of the property that is associated with the issue.
-
NotifyMeFlag(optional):
boolean
Indicates whether the registered user who reported the incident wishes to receive update notifications.
-
ObsoleteFlag(optional):
boolean
Indicates whether the issue is obsolete.
-
OriginatorSource(optional):
string
Maximum Length:
30The external source system identifier, such as 311, CRM, or CX. -
OriginatorSrId(optional):
string
Maximum Length:
30The external source unique service request ID. -
ParentId(optional):
string
Maximum Length:
50The ID of the parent incident. -
ParentKey(optional):
integer(int64)
The key of the parent incident.
-
ParentType(optional):
string
Maximum Length:
15The type of parent record, either an incident or a case. -
PrimaryIssueFlag(optional):
boolean
Indicates whether the issue is the parent of another issue.
-
Priority(optional):
string
Maximum Length:
30The incident priority code. Valid values are CRITICAL P1,HIGH P2, MEDIUM P3, and LOW P4. -
PropertyAddress1(optional):
string
Maximum Length:
240The first line of the address for the complaint. -
PropertyAddress2(optional):
string
Maximum Length:
240The second line of the address for the complaint. -
PropertyAddress3(optional):
string
Maximum Length:
240The third line of the address for the complaint. -
PropertyAddress4(optional):
string
Maximum Length:
240The fourth line of the address for the complaint. -
PropertyAddressId(optional):
integer(int64)
The property address ID.
-
PropertyCity(optional):
string
Maximum Length:
60The city for the address of the complaint. -
PropertyCoordinateX(optional):
number
The X coordinate of the property that is the subject of the complaint.
-
PropertyCoordinateY(optional):
number
The y coordinate of the property that is the subject of the complaint.
-
PropertyCountry(optional):
string
Maximum Length:
3The country for the address of the complaint. -
PropertyCounty(optional):
string
Maximum Length:
60The county of the address of the complaint. -
PropertyParcelId(optional):
integer(int64)
The property parcel ID.
-
PropertyPostalCode(optional):
string
Maximum Length:
60The postal code for the address of the complaint. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10The postal code plus four for the address of the complaint. -
PropertyProvince(optional):
string
Maximum Length:
60The province for the address of the complaint. -
PropertyState(optional):
string
Maximum Length:
60The state for the address of the complaint. -
ReferralCode(optional):
string
Maximum Length:
100The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency. -
ReportedById(optional):
string
Maximum Length:
18The ID of the person who reported the issue. -
ReviewDueDate(optional):
string(date-time)
The issue review due date.
-
ReviewerId(optional):
integer(int64)
The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.
-
Status(optional):
string
Maximum Length:
15The incident status. -
SubmitDate(optional):
string(date-time)
The issue submission date.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorIntakes-item
Type:
objectDiscriminator:
Show Source
RowType-
AgencyFlag(optional):
boolean
The identifier that indicates whether the row is created by an agency user.
-
AnonymousFlag(optional):
boolean
The identifier that indicates whether the issue is created by a guest user.
-
AttXrefTransKey(optional):
integer(int64)
The cross reference key for an attachment associated with the intake.
-
Case(optional):
array Cases
Title:
CasesThe intakes resource is used to view, create, delete, or modify code enforcement incidents and cases. -
ComplnAddress1(optional):
string
Maximum Length:
240The first line of the complainant address. -
ComplnAddress2(optional):
string
Maximum Length:
240The second line of the complainant address. -
ComplnAddress3(optional):
string
Maximum Length:
240The third line of the complainant address. -
ComplnAddress4(optional):
string
Maximum Length:
240The fourth line of the complainant address. -
ComplnCity(optional):
string
Maximum Length:
60The complainant city. -
ComplnCountry(optional):
string
Maximum Length:
3The complainant country. -
ComplnCounty(optional):
string
Maximum Length:
60The complainant county. -
ComplnPostalCode(optional):
string
Maximum Length:
60The complainant postal code. -
ComplnPostalPlusFourCode(optional):
string
Maximum Length:
10The complainant postal plus code. -
ComplnProvince(optional):
string
Maximum Length:
60The complainant province. -
ComplnState(optional):
string
Maximum Length:
60The complainant state. -
CompnEmail(optional):
string
Maximum Length:
320The complainant email. -
CompnFirstName(optional):
string
Maximum Length:
150The first name of the complainant. -
CompnLastName(optional):
string
Maximum Length:
150The last name of the complainant. -
CompnMiddleName(optional):
string
Maximum Length:
60The complainant middle name. -
CompnName(optional):
string
Maximum Length:
450The complainant name. -
CompnNameSuffix(optional):
string
Maximum Length:
30The name suffix of the complainant. -
CompnPhoneAreaCode(optional):
string
Maximum Length:
10The complainant phone area code. -
CompnPhoneCountryCode(optional):
string
Maximum Length:
10The complainant phone country code. -
CompnPhoneExtension(optional):
string
Maximum Length:
20The complainant phone extension. -
CompnPhoneNumber(optional):
string
Maximum Length:
40The complainant phone number. -
CompnTitle(optional):
string
Maximum Length:
60The title of the complainant. -
CreatedBy(optional):
string
Maximum Length:
64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
The date and time when the row was created.
-
DisclosureFlag(optional):
boolean
The identifier that indicates whether to disclose the details of an intake.
-
Incident(optional):
array Incidents
Title:
IncidentsThe intakes resource is used to view, create, delete, or modify code enforcement incidents and cases. -
IntakeId(optional):
string
Maximum Length:
50The unique identifier for an intake. -
IntakeKey(optional):
integer(int64)
An identifier for an intake that is created using autonumbering.
-
IntakeSource(optional):
string
Maximum Length:
30The source of the intake transaction. -
IntakeType(optional):
string
Maximum Length:
30The intake type. -
IssueDescription(optional):
string
Maximum Length:
1000The description of the issue or problem. -
IssueSubtypeId(optional):
string
Maximum Length:
50The unique identifier of the issue subtype. -
IssueTypeId(optional):
string
Maximum Length:
50The unique identifier of the issue type. -
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The name of the user who last updated the row. -
Latitude(optional):
number
The latitude of the property address for the complaint.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationDescr(optional):
string
Maximum Length:
1000The text description of the location of the complaint. -
Longitude(optional):
number
The longitude of the property address for the complaint.
-
NotifyMeFlag(optional):
boolean
The identifier that indicates whether to notify the user.
-
OriginatorSource(optional):
string
Maximum Length:
30The originator source. -
OriginatorSrId(optional):
string
Maximum Length:
30The originator spatial reference ID. -
ParcelIdEntered(optional):
string
Maximum Length:
30The parcel ID selected by the complainant. -
Priority(optional):
string
Maximum Length:
30The priority of the intake. -
PropertyAddress1(optional):
string
Maximum Length:
240The first line of the property address for the complaint. -
PropertyAddress2(optional):
string
Maximum Length:
240The second line of the property address for the complaint. -
PropertyAddress3(optional):
string
Maximum Length:
240The third line of the property address for the complaint. -
PropertyAddress4(optional):
string
Maximum Length:
240The fourth line of the property address for the complaint. -
PropertyCity(optional):
string
Maximum Length:
60The city of the property address for the complaint. -
PropertyCoordinateX(optional):
number
The x-coordinate of the property address for the complaint.
-
PropertyCoordinateY(optional):
number
The y-coordinate of the property address for the complaint.
-
PropertyCountry(optional):
string
Maximum Length:
3The country of the property address for the complaint. -
PropertyCounty(optional):
string
Maximum Length:
60The county of the property address for the complaint. -
PropertyPostalCode(optional):
string
Maximum Length:
60The postal code of the property address for the complaint. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10The postal plus code of the property address for the complaint. -
PropertyProvince(optional):
string
Maximum Length:
60The province of the property address for the complaint. -
PropertyState(optional):
string
Maximum Length:
60The state of the property address for the complaint. -
RecordName(optional):
string
Maximum Length:
80The record name of an intake row. -
RecordNumber(optional):
string
Maximum Length:
64The record number of an intake row. -
ReportedById(optional):
string
Maximum Length:
18The reported person ID. -
RowType:
string
Maximum Length:
30The row type of an intake. -
Severity(optional):
string
Maximum Length:
4The severity indicator. -
Srid(optional):
integer(int64)
The spatial reference ID.
-
Status(optional):
string
Maximum Length:
15The status of an intake. -
SubmitDate(optional):
string(date-time)
The date when the intake is submitted.
Nested Schema : Cases
Type:
arrayTitle:
CasesThe intakes resource is used to view, create, delete, or modify code enforcement incidents and cases.
Show Source
Nested Schema : Incidents
Type:
arrayTitle:
IncidentsThe intakes resource is used to view, create, delete, or modify code enforcement incidents and cases.
Show Source
Nested Schema : publicSectorIntakes-Case-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the agency of the case. -
AssignedId(optional):
integer(int64)
Title:
Inspector AssignedThe unique identifier of the code officer assigned to the case. -
CaseCodeReference(optional):
array Case Code References
Title:
Case Code ReferencesThe cases resource is used to view, create, delete, or modify code enforcement cases. -
CaseId(optional):
string
Title:
Case IDMaximum Length:50The identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
ChangeReason(optional):
string
The reason for modifying the case.
-
ClosedBy(optional):
string
Title:
Closed ByMaximum Length:64The name of the user who closed the case. -
ClosedDate(optional):
string(date-time)
Title:
Closed OnThe date when the case was closed. -
ClosedReason(optional):
string
Title:
Reason for ClosingMaximum Length:450The reason for closing the case. -
ComplianceDueDate(optional):
string(date)
Title:
Compliance DateThe compliance date of the case. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the row was created. -
CriticalFlag(optional):
boolean
Title:
CriticalThe switch to indicate that the case is critical. -
DistrictId(optional):
string
Maximum Length:
30The type of district ID associated with the case. -
DistrictType(optional):
string
Title:
District TypeMaximum Length:50The type of district associated with the case. -
IntakeKey(optional):
integer(int64)
The unique identifier of the intake.
-
IntakeSource(optional):
string
Maximum Length:
30The source of the case intake. -
InternalPriority(optional):
string
Title:
Internal PriorityMaximum Length:30The internal priority of the case. -
IssueDescription(optional):
string
Title:
Issue DescriptionMaximum Length:1000The description of the issue. -
IssueSubtype(optional):
string
Maximum Length:
100The name of the issue subtype associated with the case. -
IssueSubtypeId(optional):
string
Maximum Length:
50The unique identifier of the issue subtype of the case. -
IssueType(optional):
string
Maximum Length:
100The name of the issue type associated with the case. -
IssueTypeId(optional):
string
Maximum Length:
50The unique identifier of the issue type of the case. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the row. -
Latitude(optional):
number
The latitude of the location of the case.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationDescription(optional):
string
Title:
Location DescriptionMaximum Length:1000The description of the location. -
Longitude(optional):
number
The longitude of the location of the case.
-
ObsoleteFlag(optional):
boolean
The switch to indicate that the case is obsolete.
-
Priority(optional):
string
Title:
PriorityMaximum Length:30The priority of the case. -
PropertyAddress1(optional):
string
Title:
Address Line 1Maximum Length:240The first line of the property address of the case. -
PropertyAddress2(optional):
string
Title:
Address Line 2Maximum Length:240The second line of the property address of the case. -
PropertyAddress3(optional):
string
Title:
Address Line 3Maximum Length:240The third line of the property address of the case. -
PropertyAddress4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth line of the property address of the case. -
PropertyAddressId(optional):
integer(int64)
The unique identifier of the property address of the case.
-
PropertyCity(optional):
string
Title:
CityMaximum Length:60The city of the property address of the case. -
PropertyCoordinateX(optional):
number
The x-coordinate of the property address of the case.
-
PropertyCoordinateY(optional):
number
The y-coordinate of the property address of the case.
-
PropertyCountry(optional):
string
Maximum Length:
3The country of the property address of the case. -
PropertyCounty(optional):
string
Maximum Length:
60The county of the property address of the case. -
PropertyParcelId(optional):
integer(int64)
The unique identifier of the property parcel of the case.
-
PropertyPostalCode(optional):
string
Maximum Length:
60The postal code of the property address of the case. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10The postal plus code of the property address of the case. -
PropertyProvince(optional):
string
Maximum Length:
60The province of the property address of the case. -
PropertyState(optional):
string
Title:
State NameMaximum Length:60The state of the property address of the case. -
ReferralCode(optional):
string
Title:
Referred ToMaximum Length:100The unique identifier of the referral body of the case. -
ReportedById(optional):
string
Title:
Reported ByMaximum Length:64The unique identifier of the person who reported the case. -
ReviewerId(optional):
integer(int64)
Title:
Technician AssignedThe unique identifier of the code technician assigned to the case. -
SourceTrxId(optional):
string
Maximum Length:
50The unique identifier of the source transaction that created the case. -
Status(optional):
string
Title:
Case StatusMaximum Length:15The status of the case. -
SubmitDate(optional):
string(date-time)
Title:
Submitted OnThe date when the case was submitted.
Nested Schema : Case Code References
Type:
arrayTitle:
Case Code ReferencesThe cases resource is used to view, create, delete, or modify code enforcement cases.
Show Source
Nested Schema : publicSectorIntakes-Case-CaseCodeReference-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The agency identifier of the case code reference.
-
CaseId(optional):
string
Maximum Length:
50The identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CodeReferenceCode(optional):
string
Maximum Length:
100The identifier of the violation code reference. -
CodeReferenceKey(optional):
integer(int64)
The unique identifier of the case code reference.
-
CreatedBy(optional):
string
Maximum Length:
64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
The date and time when the row was created.
-
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The name of the user who last updated the row. -
links(optional):
array Items
Title:
ItemsLink Relations
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorIntakes-Incident-item
Type:
Show Source
object-
AgencyFlag(optional):
boolean
Indicates whether an agency staff member reported the issue.
-
AgencyId(optional):
integer(int32)
The unique agency ID.
-
AssignedId(optional):
integer(int64)
The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.
-
ClosedBy(optional):
string
Maximum Length:
64The person ID of the person who closed the case. -
ClosedDate(optional):
string(date-time)
The incident close date.
-
ClosedReason(optional):
string
Maximum Length:
450The reason for closing the incident. -
DisclosureFlag(optional):
boolean
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
Maximum Length:
30The unique identifier for the district of the incident location. -
DistrictType(optional):
string
Maximum Length:
50The district type for the transaction that is the source of an incident. -
DuplicateFlag(optional):
string
Maximum Length:
1Indicates whether the incident is a potential duplicate. -
IncidentId(optional):
string
Maximum Length:
50A logical ID for the incident transaction. -
IncidentKey(optional):
integer(int64)
The unique identifier for an incident. This number is created using autonumbering.
-
IntakeKey(optional):
integer(int64)
The key from the intake record. The intake record is the parent of the incident record.
-
IntakeSource(optional):
string
Maximum Length:
30The transaction type for the transaction that is the source of an incident. -
IssueDescription(optional):
string
Maximum Length:
1000The complainant's issue description. -
IssueSubtype(optional):
string
Maximum Length:
100The description of the issue subtype. -
IssueSubtypeCode(optional):
string
Maximum Length:
40The code for the issue subtype. -
IssueSubtypeId(optional):
string
Maximum Length:
50The logical issue subtype ID. -
IssueType(optional):
string
Maximum Length:
100The description of the issue type. -
IssueTypeId(optional):
string
Maximum Length:
50The logical issue type ID. -
Latitude(optional):
number
The latitude of the property that is associated with the issue.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationDescr(optional):
string
Maximum Length:
1000Additional issue location information such as an apartment number or descriptive details. -
Longitude(optional):
number
The longitude of the property that is associated with the issue.
-
NotifyMeFlag(optional):
boolean
Indicates whether the registered user who reported the incident wishes to receive update notifications.
-
ObsoleteFlag(optional):
boolean
Indicates whether the issue is obsolete.
-
OriginatorSource(optional):
string
Maximum Length:
30The external source system identifier, such as 311, CRM, or CX. -
OriginatorSrId(optional):
string
Maximum Length:
30The external source unique service request ID. -
ParentId(optional):
string
Maximum Length:
50The ID of the parent incident. -
ParentKey(optional):
integer(int64)
The key of the parent incident.
-
ParentType(optional):
string
Maximum Length:
15The type of parent record, either an incident or a case. -
PrimaryIssueFlag(optional):
boolean
Indicates whether the issue is the parent of another issue.
-
Priority(optional):
string
Maximum Length:
30The incident priority code. Valid values are CRITICAL P1,HIGH P2, MEDIUM P3, and LOW P4. -
PropertyAddress1(optional):
string
Maximum Length:
240The first line of the address for the complaint. -
PropertyAddress2(optional):
string
Maximum Length:
240The second line of the address for the complaint. -
PropertyAddress3(optional):
string
Maximum Length:
240The third line of the address for the complaint. -
PropertyAddress4(optional):
string
Maximum Length:
240The fourth line of the address for the complaint. -
PropertyAddressId(optional):
integer(int64)
The property address ID.
-
PropertyCity(optional):
string
Maximum Length:
60The city for the address of the complaint. -
PropertyCoordinateX(optional):
number
The X coordinate of the property that is the subject of the complaint.
-
PropertyCoordinateY(optional):
number
The y coordinate of the property that is the subject of the complaint.
-
PropertyCountry(optional):
string
Maximum Length:
3The country for the address of the complaint. -
PropertyCounty(optional):
string
Maximum Length:
60The county of the address of the complaint. -
PropertyParcelId(optional):
integer(int64)
The property parcel ID.
-
PropertyPostalCode(optional):
string
Maximum Length:
60The postal code for the address of the complaint. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10The postal code plus four for the address of the complaint. -
PropertyProvince(optional):
string
Maximum Length:
60The province for the address of the complaint. -
PropertyState(optional):
string
Maximum Length:
60The state for the address of the complaint. -
ReferralCode(optional):
string
Maximum Length:
100The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency. -
ReportedById(optional):
string
Maximum Length:
18The ID of the person who reported the issue. -
ReviewDueDate(optional):
string(date-time)
The issue review due date.
-
ReviewerId(optional):
integer(int64)
The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.
-
Status(optional):
string
Maximum Length:
15The incident status. -
SubmitDate(optional):
string(date-time)
The issue submission date.