Create a set of case citations
post
/fscmRestApi/resources/11.13.18.05/publicSectorCitations
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the case citation. -
CaseComplianceDueDate: string
(date)
The compliance due date of the case associated with the citation.
-
CaseKey: integer
(int64)
Default Value:
0
The unique identifier of the case. -
CaseNoticeKey: integer
(int64)
The unique identifier of the case notice for the case citation.
-
CaseNoticePuid: string
The public unique identifier of the migrated case notice record.
-
CasePuid(required): string
Maximum Length:
480
The public unique identifier of the migrated case record. -
CitationId: string
Title:
Citation ID
Maximum Length:50
Default Value:NEXT
The unique identifier of the case citation. -
CitationKey: integer
(int64)
The unique identifier of the case citation.
-
CitationPuid(required): string
Maximum Length:
480
The public unique identifier of the migrated citation record. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments entered for the case citation. -
Description(required): string
Title:
Description
Maximum Length:1000
The description of the case citation. -
DueDate: string
(date)
Title:
Due Date
The due date for the case citation. -
FeeRecordKey: integer
(int64)
The unique identifier of the case fee record for the case citation.
-
FeeRecordPuid: string
The public unique identifier of the migrated case fee record.
-
PayCitation: 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.
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
Nested Schema : publicSectorCitations-PayCitation-FeeRecords-item-post-request
Type:
Show Source
object
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorCitations-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the case citation. -
CaseComplianceDueDate: string
(date)
The compliance due date of the case associated with the citation.
-
CaseId: string
Title:
Case ID
Read Only:true
Maximum Length:50
The unique identifier of the case. -
CaseKey: integer
(int64)
Default Value:
0
The unique identifier of the case. -
CaseNoticeKey: integer
(int64)
The unique identifier of the case notice for the case citation.
-
CaseNoticePuid: string
The public unique identifier of the migrated case notice record.
-
CasePuid: string
Maximum Length:
480
The public unique identifier of the migrated case record. -
CitationId: string
Title:
Citation ID
Maximum Length:50
Default Value:NEXT
The unique identifier of the case citation. -
CitationKey: integer
(int64)
The unique identifier of the case citation.
-
CitationPuid: string
Maximum Length:
480
The public unique identifier of the migrated citation record. -
CodeViolation: string
Read Only:
true
Indicates the total number of code violations linked to the citation. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments entered for the case citation. -
CreatedByName: string
Title:
Created By
Read Only:true
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
Description: string
Title:
Description
Maximum Length:1000
The description of the case citation. -
DueDate: string
(date)
Title:
Due Date
The due date for the case citation. -
FeeRecordKey: integer
(int64)
The unique identifier of the case fee record for the case citation.
-
FeeRecordPuid: string
The public unique identifier of the migrated case fee record.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayCitation: 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: string
(date-time)
Title:
Payment Date
Read Only:true
The date when the citation fee was paid.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorCitations-PayCitation-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
Default Value:1
The agency identifier of the case citation. -
CaseId: string
Read Only:
true
Maximum Length:255
The unique identifier of the case. -
CaseKey: integer
(int64)
Read Only:
true
Default Value:0
The unique identifier of the case. -
CaseStatus: string
Read Only:
true
Maximum Length:30
The status of the case associated with the citation. -
CaseSubmitDate: string
(date-time)
Read Only:
true
The date on which the case was submitted. -
CitationDueDate: string
(date)
Title:
Citation Due Date
Read Only:true
The due date of case associated with the citation. -
CitationId: string
Title:
Citation ID
Read Only:true
Maximum Length:50
Default Value:NEXT
The unique identifier of the case citation. -
CitationKey: integer
(int64)
Read Only:
true
The unique identifier of the case citation. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:3
Default Value:USD
The currency code of the citation fee amount. -
DueDate: string
(date)
Title:
Due Date
Read Only:true
The due date for the case citation. -
FeeRecordKey: integer
(int64)
Read Only:
true
The unique identifier of the case fee record for the case citation. -
FeeRecords: array
Fee Records
Title:
Fee Records
The fee records resource is used to view fee records associated with a citation. -
FeeStatus: string
Title:
Status
Read Only:true
Maximum Length:15
Default Value:ORA_DUE
The fee status of the case citation. -
IssueSubtype: string
Read Only:
true
Maximum Length:100
The subtype of the issue that belongs to the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentReferenceId: string
Read Only:
true
Maximum Length:50
The unique identifier of the payment reference for the paid amount. -
TotalFeeAmount: number
Read Only:
true
The total fee amount for the case citation. -
TotalFeeAmountDue: number
Title:
Total Due
Read Only:true
The total fee amount due for the case associated with the citation. -
TotalFeeAmountPaymentInProgress: number
Title:
Payment in Progress
Read Only:true
The total fee amount for the case associated with the citation for which the payment is in progress.
Nested Schema : Fee Records
Type:
array
Title:
Fee Records
The fee records resource is used to view fee records associated with a citation.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCitations-PayCitation-FeeRecords-item-response
Type:
Show Source
object
-
CitationKey: integer
(int64)
Read Only:
true
The unique identifier of the case associated with the citation. -
CurrencyCode: string
Read Only:
true
Maximum Length:3
The currency code of the fee record. -
DueDate: string
(date)
Read Only:
true
The due date of the fee record. -
FeeAmount: number
Read Only:
true
The amount of the fee record. -
FeeQuantity: number
Read Only:
true
The quantity of the fee record. -
FeeRecordKey: integer
Read Only:
true
The unique identifier of the fee record. -
FeeStatus: string
Read Only:
true
Maximum Length:15
The status of the fee record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentFeeRecordKey: integer
(int64)
Read Only:
true
The parent fee record identifier of the fee record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PayCitation
-
Parameters:
- CitationKey:
$request.path.CitationKey
The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases. - CitationKey: