Jump to

• Request
• Response

Get a case citation

get

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

Request

Path Parameters

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

Query Parameters

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

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : 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.
• CaseNoticePuid(optional): string
  The public unique identifier of the migrated case notice record.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• 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.
• CitationPuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated citation record.
• 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.
• FeeRecordPuid(optional): string
  The public unique identifier of the migrated case fee record.
• 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 citation payment resource is used to view a citation payment. 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."
        },
        "CaseNoticePuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated case notice record."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record."
        },
        "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."
        },
        "CitationPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated citation record."
        },
        "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."
        },
        "FeeRecordPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated case fee record."
        },
        "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 citation payment resource is used to view a citation payment. 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 citation payment resource is used to view a citation payment. 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 citation payment resource is used to view a citation payment. 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