Jump to

• Request
• Response

Update a case citation

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCitations/{CitationKey}

Request

Supported Media Types

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

Path Parameters

• CitationKey: integer
  The unique identifier of the case citation.

Body ()

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

Root Schema : publicSectorCitations-item

Type: object

Show Source

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

  The agency identifier of the case citation.
• CaseComplianceDueDate(optional): string(date)
  The compliance due date of the case associated with the citation.
• CaseId(optional): string
  Title: Case ID

  Maximum Length: 50

  The unique identifier of the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CaseNoticeKey(optional): integer(int64)
  The unique identifier of the case notice for the case citation.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the case citation.
• CitationKey(optional): integer(int64)
  The unique identifier of the case citation.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered for the case citation.
• 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.
• Description(optional): string
  Title: Description

  Maximum Length: 1000

  The description of the case citation.
• DueDate(optional): string(date)
  Title: Due Date

  The due date for the case citation.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record for the case citation.
• 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.
• links(optional): array Items
  Title: Items

  Link Relations
• PayCitation(optional): array Citation Payments
  Title: Citation Payments

  The case citation resource is used to view, create, or modify a case citation. Case citations are used in Code Enforcement cases.
• PaymentDate(optional): string(date-time)
  Title: Payment Date

  The date when the citation fee was paid.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case citation.",
            "title":"Agency ID"
        },
        "CaseComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The compliance due date of the case associated with the citation."
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case.",
            "title":"Case ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CaseNoticeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case notice for the case citation."
        },
        "CitationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case citation.",
            "title":"Citation ID"
        },
        "CitationKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case citation."
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered for the case citation.",
            "title":"Comments"
        },
        "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"
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the case citation.",
            "title":"Description"
        },
        "DueDate":{
            "format":"date",
            "type":"string",
            "description":"The due date for the case citation.",
            "title":"Due Date"
        },
        "FeeRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case fee record for the case citation."
        },
        "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"
        },
        "PayCitation":{
            "items":{
                "$ref":"#/definitions/publicSectorCitations-PayCitation-item"
            },
            "type":"array",
            "description":"The case citation resource is used to view, create, or modify a case citation. Case citations are used in Code Enforcement cases.",
            "title":"Citation Payments"
        },
        "PaymentDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the citation fee was paid.",
            "title":"Payment 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 : Citation Payments

Type: array

Title: Citation Payments

The case citation resource is used to view, create, or modify a case citation. Case citations are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorCitations-PayCitation-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCitations-PayCitation-item"
    },
    "type":"array",
    "description":"The case citation resource is used to view, create, or modify a case citation. Case citations are used in Code Enforcement cases.",
    "title":"Citation Payments"
}

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"
}

Nested Schema : publicSectorCitations-PayCitation-item

Type: object

Show Source

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

  The agency identifier of the case citation.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CaseStatus(optional): string
  Maximum Length: 30

  The status of the case associated with the citation.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the case citation.
• CitationKey(optional): integer(int64)
  The unique identifier of the case citation.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• CurrencyCode(optional): string
  Title: Currency

  Maximum Length: 3

  The currency code of the citation fee amount.
• DueDate(optional): string(date)
  Title: Due Date

  The due date for the case citation.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record for the case citation.
• FeeStatus(optional): string
  Title: Status

  Maximum Length: 15

  The fee status of the case citation.
• IssueSubtype(optional): string
  Maximum Length: 100

  The subtype of the issue that belongs to the case.
• links(optional): array Items
  Title: Items

  Link Relations
• PaymentReferenceId(optional): string
  Maximum Length: 50

  The unique identifier of the payment reference for the paid amount.
• TotalFeeAmount(optional): number
  The total fee amount for the case citation.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case citation.",
            "title":"Agency ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CaseStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the case associated with the citation."
        },
        "CitationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case citation.",
            "title":"Citation ID"
        },
        "CitationKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case citation."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of the citation fee amount.",
            "title":"Currency"
        },
        "DueDate":{
            "format":"date",
            "type":"string",
            "description":"The due date for the case citation.",
            "title":"Due Date"
        },
        "FeeRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case fee record for the case citation."
        },
        "FeeStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The fee status of the case citation.",
            "title":"Status"
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The subtype of the issue that belongs to the case."
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the payment reference for the paid amount."
        },
        "TotalFeeAmount":{
            "type":"number",
            "description":"The total fee amount for the case citation."
        },
        "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"
}

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 : publicSectorCitations-item

Type: object

Show Source

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

  The agency identifier of the case citation.
• CaseComplianceDueDate(optional): string(date)
  The compliance due date of the case associated with the citation.
• CaseId(optional): string
  Title: Case ID

  Maximum Length: 50

  The unique identifier of the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CaseNoticeKey(optional): integer(int64)
  The unique identifier of the case notice for the case citation.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the case citation.
• CitationKey(optional): integer(int64)
  The unique identifier of the case citation.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered for the case citation.
• 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.
• Description(optional): string
  Title: Description

  Maximum Length: 1000

  The description of the case citation.
• DueDate(optional): string(date)
  Title: Due Date

  The due date for the case citation.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record for the case citation.
• 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.
• links(optional): array Items
  Title: Items

  Link Relations
• PayCitation(optional): array Citation Payments
  Title: Citation Payments

  The case citation resource is used to view, create, or modify a case citation. Case citations are used in Code Enforcement cases.
• PaymentDate(optional): string(date-time)
  Title: Payment Date

  The date when the citation fee was paid.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case citation.",
            "title":"Agency ID"
        },
        "CaseComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The compliance due date of the case associated with the citation."
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case.",
            "title":"Case ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CaseNoticeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case notice for the case citation."
        },
        "CitationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case citation.",
            "title":"Citation ID"
        },
        "CitationKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case citation."
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered for the case citation.",
            "title":"Comments"
        },
        "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"
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the case citation.",
            "title":"Description"
        },
        "DueDate":{
            "format":"date",
            "type":"string",
            "description":"The due date for the case citation.",
            "title":"Due Date"
        },
        "FeeRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case fee record for the case citation."
        },
        "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"
        },
        "PayCitation":{
            "items":{
                "$ref":"#/definitions/publicSectorCitations-PayCitation-item"
            },
            "type":"array",
            "description":"The case citation resource is used to view, create, or modify a case citation. Case citations are used in Code Enforcement cases.",
            "title":"Citation Payments"
        },
        "PaymentDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the citation fee was paid.",
            "title":"Payment 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 : Citation Payments

Type: array

Title: Citation Payments

The case citation resource is used to view, create, or modify a case citation. Case citations are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorCitations-PayCitation-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCitations-PayCitation-item"
    },
    "type":"array",
    "description":"The case citation resource is used to view, create, or modify a case citation. Case citations are used in Code Enforcement cases.",
    "title":"Citation Payments"
}

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"
}

Nested Schema : publicSectorCitations-PayCitation-item

Type: object

Show Source

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

  The agency identifier of the case citation.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CaseStatus(optional): string
  Maximum Length: 30

  The status of the case associated with the citation.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the case citation.
• CitationKey(optional): integer(int64)
  The unique identifier of the case citation.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• CurrencyCode(optional): string
  Title: Currency

  Maximum Length: 3

  The currency code of the citation fee amount.
• DueDate(optional): string(date)
  Title: Due Date

  The due date for the case citation.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record for the case citation.
• FeeStatus(optional): string
  Title: Status

  Maximum Length: 15

  The fee status of the case citation.
• IssueSubtype(optional): string
  Maximum Length: 100

  The subtype of the issue that belongs to the case.
• links(optional): array Items
  Title: Items

  Link Relations
• PaymentReferenceId(optional): string
  Maximum Length: 50

  The unique identifier of the payment reference for the paid amount.
• TotalFeeAmount(optional): number
  The total fee amount for the case citation.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case citation.",
            "title":"Agency ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CaseStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the case associated with the citation."
        },
        "CitationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case citation.",
            "title":"Citation ID"
        },
        "CitationKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case citation."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of the citation fee amount.",
            "title":"Currency"
        },
        "DueDate":{
            "format":"date",
            "type":"string",
            "description":"The due date for the case citation.",
            "title":"Due Date"
        },
        "FeeRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case fee record for the case citation."
        },
        "FeeStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The fee status of the case citation.",
            "title":"Status"
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The subtype of the issue that belongs to the case."
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the payment reference for the paid amount."
        },
        "TotalFeeAmount":{
            "type":"number",
            "description":"The total fee amount for the case citation."
        },
        "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"
}

Back to Top