Create a set of case citations
post
/fscmRestApi/resources/11.13.18.05/publicSectorCitations
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 : publicSectorCitations-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the case citation. -
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.
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : publicSectorCitations-PayCitation-item
Type:
Show Source
object
-
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.
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 : publicSectorCitations-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the case citation. -
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.
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : publicSectorCitations-PayCitation-item
Type:
Show Source
object
-
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.