Jump to

• Request
• Response

Update a case

patch

/fscmRestApi/resources/11.13.18.05/publicSectorIntakes/{IntakeKey}/child/Case/{CaseKey}

Request

Supported Media Types

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

Path Parameters

• CaseKey: integer
  The unique identifier of the case.
• IntakeKey: integer
  An identifier for an intake that is created using autonumbering.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorIntakes-Case-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency of the case.
• AssignedId(optional): integer(int64)
  Title: Inspector Assigned

  The unique identifier of the code officer assigned to the case.
• CaseCodeReference(optional): array Case Code References
  Title: Case Code References

  The cases resource is used to view, create, delete, or modify code enforcement cases.
• CaseId(optional): string
  Title: Case ID

  Maximum Length: 50

  The 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 By

  Maximum Length: 64

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

  The date when the case was closed.
• ClosedReason(optional): string
  Title: Reason for Closing

  Maximum Length: 450

  The reason for closing the case.
• ComplianceDueDate(optional): string(date)
  Title: Compliance Date

  The compliance date of the case.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• CriticalFlag(optional): boolean
  Title: Critical

  The switch to indicate that the case is critical.
• DistrictId(optional): string
  Maximum Length: 30

  The type of district ID associated with the case.
• DistrictType(optional): string
  Title: District Type

  Maximum Length: 50

  The type of district associated with the case.
• IntakeKey(optional): integer(int64)
  The unique identifier of the intake.
• IntakeSource(optional): string
  Maximum Length: 30

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

  Maximum Length: 30

  The internal priority of the case.
• IssueDescription(optional): string
  Title: Issue Description

  Maximum Length: 1000

  The description of the issue.
• IssueSubtype(optional): string
  Maximum Length: 100

  The name of the issue subtype associated with the case.
• IssueSubtypeId(optional): string
  Maximum Length: 50

  The unique identifier of the issue subtype of the case.
• IssueType(optional): string
  Maximum Length: 100

  The name of the issue type associated with the case.
• IssueTypeId(optional): string
  Maximum Length: 50

  The unique identifier of the issue type of the case.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The 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: Items

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

  Maximum Length: 1000

  The 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: Priority

  Maximum Length: 30

  The priority of the case.
• PropertyAddress1(optional): string
  Title: Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  The 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: City

  Maximum Length: 60

  The 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: 3

  The country of the property address of the case.
• PropertyCounty(optional): string
  Maximum Length: 60

  The 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: 60

  The postal code of the property address of the case.
• PropertyPostalPlusFourCode(optional): string
  Maximum Length: 10

  The postal plus code of the property address of the case.
• PropertyProvince(optional): string
  Maximum Length: 60

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

  Maximum Length: 60

  The state of the property address of the case.
• ReferralCode(optional): string
  Title: Referred To

  Maximum Length: 100

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

  Maximum Length: 64

  The unique identifier of the person who reported the case.
• ReviewerId(optional): integer(int64)
  Title: Technician Assigned

  The unique identifier of the code technician assigned to the case.
• SourceTrxId(optional): string
  Maximum Length: 50

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

  Maximum Length: 15

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

  The date when the case was submitted.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency of the case.",
            "title":"Agency ID"
        },
        "AssignedId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the code officer assigned to the case.",
            "title":"Inspector Assigned"
        },
        "CaseCodeReference":{
            "items":{
                "$ref":"#/definitions/publicSectorIntakes-Case-CaseCodeReference-item"
            },
            "type":"array",
            "description":"The cases resource is used to view, create, delete, or modify code enforcement cases.",
            "title":"Case Code References"
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the case.",
            "title":"Case ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "ChangeReason":{
            "type":"string",
            "description":"The reason for modifying the case."
        },
        "ClosedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who closed the case.",
            "title":"Closed By"
        },
        "ClosedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the case was closed.",
            "title":"Closed On"
        },
        "ClosedReason":{
            "maxLength":450,
            "type":"string",
            "description":"The reason for closing the case.",
            "title":"Reason for Closing"
        },
        "ComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The compliance date of the case.",
            "title":"Compliance Date"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "CriticalFlag":{
            "type":"boolean",
            "description":"The switch to indicate that the case is critical.",
            "title":"Critical"
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The type of district ID associated with the case."
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The type of district associated with the case.",
            "title":"District Type"
        },
        "IntakeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the intake."
        },
        "IntakeSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the case intake."
        },
        "InternalPriority":{
            "maxLength":30,
            "type":"string",
            "description":"The internal priority of the case.",
            "title":"Internal Priority"
        },
        "IssueDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the issue.",
            "title":"Issue Description"
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue subtype associated with the case."
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case."
        },
        "IssueType":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue type associated with the case."
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the issue type of the case."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the location of the case."
        },
        "LocationDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the location.",
            "title":"Location Description"
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the location of the case."
        },
        "ObsoleteFlag":{
            "type":"boolean",
            "description":"The switch to indicate that the case is obsolete."
        },
        "Priority":{
            "maxLength":30,
            "type":"string",
            "description":"The priority of the case.",
            "title":"Priority"
        },
        "PropertyAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the property address of the case.",
            "title":"Address Line 1"
        },
        "PropertyAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the property address of the case.",
            "title":"Address Line 2"
        },
        "PropertyAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the property address of the case.",
            "title":"Address Line 3"
        },
        "PropertyAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the property address of the case.",
            "title":"Address Line 4"
        },
        "PropertyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the property address of the case."
        },
        "PropertyCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the property address of the case.",
            "title":"City"
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The x-coordinate of the property address of the case."
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The y-coordinate of the property address of the case."
        },
        "PropertyCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the property address of the case."
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the property address of the case."
        },
        "PropertyParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the property parcel of the case."
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the property address of the case."
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the property address of the case."
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the property address of the case."
        },
        "PropertyState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the property address of the case.",
            "title":"State Name"
        },
        "ReferralCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the referral body of the case.",
            "title":"Referred To"
        },
        "ReportedById":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the person who reported the case.",
            "title":"Reported By"
        },
        "ReviewerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the code technician assigned to the case.",
            "title":"Technician Assigned"
        },
        "SourceTrxId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the source transaction that created the case."
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case.",
            "title":"Case Status"
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the case was submitted.",
            "title":"Submitted On"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Case Code References

Type: array

Title: Case Code References

The cases resource is used to view, create, delete, or modify code enforcement cases.

Show Source

• Array of: object publicSectorIntakes-Case-CaseCodeReference-item

{
    "items":{
        "$ref":"#/definitions/publicSectorIntakes-Case-CaseCodeReference-item"
    },
    "type":"array",
    "description":"The cases resource is used to view, create, delete, or modify code enforcement cases.",
    "title":"Case Code References"
}

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 : publicSectorIntakes-Case-CaseCodeReference-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the case code reference.
• CaseId(optional): string
  Maximum Length: 50

  The identifier of the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CodeReferenceCode(optional): string
  Maximum Length: 100

  The identifier of the violation code reference.
• CodeReferenceKey(optional): integer(int64)
  The unique identifier of the case code reference.
• CreatedBy(optional): string
  Maximum Length: 64

  The 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: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case code reference."
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the case."
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CodeReferenceCode":{
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the violation code reference."
        },
        "CodeReferenceKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case code reference."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "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

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 : publicSectorIntakes-Case-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency of the case.
• AssignedId(optional): integer(int64)
  Title: Inspector Assigned

  The unique identifier of the code officer assigned to the case.
• CaseCodeReference(optional): array Case Code References
  Title: Case Code References

  The cases resource is used to view, create, delete, or modify code enforcement cases.
• CaseId(optional): string
  Title: Case ID

  Maximum Length: 50

  The 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 By

  Maximum Length: 64

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

  The date when the case was closed.
• ClosedReason(optional): string
  Title: Reason for Closing

  Maximum Length: 450

  The reason for closing the case.
• ComplianceDueDate(optional): string(date)
  Title: Compliance Date

  The compliance date of the case.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• CriticalFlag(optional): boolean
  Title: Critical

  The switch to indicate that the case is critical.
• DistrictId(optional): string
  Maximum Length: 30

  The type of district ID associated with the case.
• DistrictType(optional): string
  Title: District Type

  Maximum Length: 50

  The type of district associated with the case.
• IntakeKey(optional): integer(int64)
  The unique identifier of the intake.
• IntakeSource(optional): string
  Maximum Length: 30

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

  Maximum Length: 30

  The internal priority of the case.
• IssueDescription(optional): string
  Title: Issue Description

  Maximum Length: 1000

  The description of the issue.
• IssueSubtype(optional): string
  Maximum Length: 100

  The name of the issue subtype associated with the case.
• IssueSubtypeId(optional): string
  Maximum Length: 50

  The unique identifier of the issue subtype of the case.
• IssueType(optional): string
  Maximum Length: 100

  The name of the issue type associated with the case.
• IssueTypeId(optional): string
  Maximum Length: 50

  The unique identifier of the issue type of the case.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The 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: Items

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

  Maximum Length: 1000

  The 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: Priority

  Maximum Length: 30

  The priority of the case.
• PropertyAddress1(optional): string
  Title: Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  The 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: City

  Maximum Length: 60

  The 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: 3

  The country of the property address of the case.
• PropertyCounty(optional): string
  Maximum Length: 60

  The 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: 60

  The postal code of the property address of the case.
• PropertyPostalPlusFourCode(optional): string
  Maximum Length: 10

  The postal plus code of the property address of the case.
• PropertyProvince(optional): string
  Maximum Length: 60

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

  Maximum Length: 60

  The state of the property address of the case.
• ReferralCode(optional): string
  Title: Referred To

  Maximum Length: 100

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

  Maximum Length: 64

  The unique identifier of the person who reported the case.
• ReviewerId(optional): integer(int64)
  Title: Technician Assigned

  The unique identifier of the code technician assigned to the case.
• SourceTrxId(optional): string
  Maximum Length: 50

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

  Maximum Length: 15

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

  The date when the case was submitted.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency of the case.",
            "title":"Agency ID"
        },
        "AssignedId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the code officer assigned to the case.",
            "title":"Inspector Assigned"
        },
        "CaseCodeReference":{
            "items":{
                "$ref":"#/definitions/publicSectorIntakes-Case-CaseCodeReference-item"
            },
            "type":"array",
            "description":"The cases resource is used to view, create, delete, or modify code enforcement cases.",
            "title":"Case Code References"
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the case.",
            "title":"Case ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "ChangeReason":{
            "type":"string",
            "description":"The reason for modifying the case."
        },
        "ClosedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who closed the case.",
            "title":"Closed By"
        },
        "ClosedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the case was closed.",
            "title":"Closed On"
        },
        "ClosedReason":{
            "maxLength":450,
            "type":"string",
            "description":"The reason for closing the case.",
            "title":"Reason for Closing"
        },
        "ComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The compliance date of the case.",
            "title":"Compliance Date"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "CriticalFlag":{
            "type":"boolean",
            "description":"The switch to indicate that the case is critical.",
            "title":"Critical"
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The type of district ID associated with the case."
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The type of district associated with the case.",
            "title":"District Type"
        },
        "IntakeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the intake."
        },
        "IntakeSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the case intake."
        },
        "InternalPriority":{
            "maxLength":30,
            "type":"string",
            "description":"The internal priority of the case.",
            "title":"Internal Priority"
        },
        "IssueDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the issue.",
            "title":"Issue Description"
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue subtype associated with the case."
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case."
        },
        "IssueType":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue type associated with the case."
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the issue type of the case."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the location of the case."
        },
        "LocationDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the location.",
            "title":"Location Description"
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the location of the case."
        },
        "ObsoleteFlag":{
            "type":"boolean",
            "description":"The switch to indicate that the case is obsolete."
        },
        "Priority":{
            "maxLength":30,
            "type":"string",
            "description":"The priority of the case.",
            "title":"Priority"
        },
        "PropertyAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the property address of the case.",
            "title":"Address Line 1"
        },
        "PropertyAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the property address of the case.",
            "title":"Address Line 2"
        },
        "PropertyAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the property address of the case.",
            "title":"Address Line 3"
        },
        "PropertyAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the property address of the case.",
            "title":"Address Line 4"
        },
        "PropertyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the property address of the case."
        },
        "PropertyCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the property address of the case.",
            "title":"City"
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The x-coordinate of the property address of the case."
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The y-coordinate of the property address of the case."
        },
        "PropertyCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the property address of the case."
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the property address of the case."
        },
        "PropertyParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the property parcel of the case."
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the property address of the case."
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the property address of the case."
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the property address of the case."
        },
        "PropertyState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the property address of the case.",
            "title":"State Name"
        },
        "ReferralCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the referral body of the case.",
            "title":"Referred To"
        },
        "ReportedById":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the person who reported the case.",
            "title":"Reported By"
        },
        "ReviewerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the code technician assigned to the case.",
            "title":"Technician Assigned"
        },
        "SourceTrxId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the source transaction that created the case."
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case.",
            "title":"Case Status"
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the case was submitted.",
            "title":"Submitted On"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Case Code References

Type: array

Title: Case Code References

The cases resource is used to view, create, delete, or modify code enforcement cases.

Show Source

• Array of: object publicSectorIntakes-Case-CaseCodeReference-item

{
    "items":{
        "$ref":"#/definitions/publicSectorIntakes-Case-CaseCodeReference-item"
    },
    "type":"array",
    "description":"The cases resource is used to view, create, delete, or modify code enforcement cases.",
    "title":"Case Code References"
}

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 : publicSectorIntakes-Case-CaseCodeReference-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the case code reference.
• CaseId(optional): string
  Maximum Length: 50

  The identifier of the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CodeReferenceCode(optional): string
  Maximum Length: 100

  The identifier of the violation code reference.
• CodeReferenceKey(optional): integer(int64)
  The unique identifier of the case code reference.
• CreatedBy(optional): string
  Maximum Length: 64

  The 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: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case code reference."
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the case."
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CodeReferenceCode":{
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the violation code reference."
        },
        "CodeReferenceKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case code reference."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "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