Get all citation notices
get
/fscmRestApi/resources/11.13.18.05/publicSectorListCitationNotices
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- CompletedNoticesFinder: Finds the completed case notice that matches the specified search criteria.
Finder Variables:- reviewerId; integer; The identifier of the code technician.
- searchValue; string; Finds the completed case notice that matches the specified search value.
- InProgressNoticesFinder: Finds the in-progress case notice that matches the specified search criteria.
Finder Variables:- reviewerId; integer; The identifier of the code technician.
- searchValue; string; The search value.
- OpenNoticesFinder: Finds the open case notice that matches the specified search value.
Finder Variables:- reviewerId; integer; The identifier of the code technician.
- searchValue; string; Finds the open case notice that matches the specified search value.
- PrimaryKey: Finds the case notice that matches the specified search criteria.
Finder Variables:- CaseNoticeKey; integer; The unique identifier of the case notice.
- UnassignedNoticesFinder: Finds the unassigned case notice that matches the specified search criteria.
Finder Variables:- searchValue; string; Finds the completed case notice that matches the specified search value.
- CompletedNoticesFinder: Finds the completed case notice that matches the specified search criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The agency identifier for the case notice.
- AssignedCodeOfficerName; string; The code officer assigned to the case.
- AssignedCodeTechnicianName; string; The code technician assigned to the case.
- AssignedId; string; The unique ID of the person assigned to the case.
- BipTemplateId; string; The report definition of the case notice.
- CaseContactKey; integer; The unique identifier of the case notice contact.
- CaseId; string; The unique identifier of the case.
- CaseKey; integer; The unique identifier of the case.
- CaseNoticeId; string; The unique identifier of the case notice.
- CaseNoticeKey; integer; The unique identifier of the case notice.
- CaseStatus; string; The status of the case.
- CitationDescription; string; The description of the case citation.
- CitationDueDate; string; The due date for the case citation.
- CitationId; string; The unique identifier of the case citation.
- CitationKey; integer; The unique identifier of the case citation.
- Comments; string; The comments entered for the case notice.
- ComplianceDueDate; string; The compliance due date for the case.
- CreationDate; string; The date and time when the row was created.
- IssueSubtype; string; The subtype of the issue for the case.
- IssueSubtypeId; string; The identifier of the issue subtype for the case notice.
- IssueTypeId; string; The identifier of the issue type for the case notice.
- LastUpdateDate; string; The date and time when the row was last updated.
- NoticeSource; string; The source of the case notice.
- NoticeStatus; string; The status of the case notice.
- NoticeStatusText; string; The notice status text of the citation notice.
- NoticeTypeCode; string; The notice type code for the case notice.
- NoticeTypeName; string; The name of notice type.
- OutputFormat; string; The output format of the notice generated.
- ProcessInstanceId; string; The process instance identifier of the workflow associated with the case.
- PropertyAddress1; string; The first line for the property address related to the case.
- PropertyAddress2; string; The second line for the property address related to the case.
- PropertyAddress3; string; The third line for the property address related to the case.
- PropertyAddress4; string; The fourth line for the property address related to the case.
- PropertyAddressId; integer; The unique identifier of the property address for the case.
- PropertyCity; string; The city in which the property related to the case is located.
- PropertyCoordinateX; number; The latitude of the property related to the case.
- PropertyCoordinateY; number; The longitude of the property related to the case.
- PropertyCountry; string; The country in which the property related to the case is located.
- PropertyCounty; string; The county in which the property related to the case is located.
- PropertyParcelId; integer; The unique identifier of the property address related to the case.
- PropertyPostalCode; string; The postal code of the property address related to the case.
- PropertyPostalPluscode; string; The postal plus code of the property address related to the case.
- PropertyProvince; string; The province in which the property related to the case is located.
- PropertyState; string; The state in which the property related to the case is located.
- ReceivedDate; string; The date on which the notice was received.
- ResponsiblePartyAddress1; string; The responsible party's address 1.
- ResponsiblePartyAddress2; string; The responsible party's address 2.
- ResponsiblePartyAddress3; string; The responsible party's address 3.
- ResponsiblePartyAddress4; string; The responsible party's address 4.
- ResponsiblePartyCity; string; The responsible party's city.
- ResponsiblePartyCountry; string; The responsible party's country.
- ResponsiblePartyDisplayname; string; The display name of the responsible party.
- ResponsiblePartyFirstName; string; The responsible party first name.
- ResponsiblePartyLastName; string; The last name of the responsible party.
- ResponsiblePartyPostal; string; The responsible party's postal code.
- ResponsiblePartyState; string; The responsible party's state.
- ReviewerId; integer; The code technician identifier for the case.
- Sequence; integer; The sequence of the case notice.
- ShippedBy; string; The name of the shipping carrier that is delivering the case notice.
- ShippedDate; string; The date on which the case notice was shipped.
- TrackingId; string; The tracking identifier of the shipping carrier delivering the case notice.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorListCitationNotices
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorListCitationNotices-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
Default Value:1
The agency identifier for the case notice. -
AssignedCodeOfficerName: string
Read Only:
true
Maximum Length:255
The code officer assigned to the case. -
AssignedCodeTechnicianName: string
Read Only:
true
Maximum Length:255
The code technician assigned to the case. -
AssignedId: string
Read Only:
true
Maximum Length:18
The unique ID of the person assigned to the case. -
BipTemplateId: string
Title:
Report Mapping
Read Only:true
Maximum Length:32
The report definition of the case notice. -
CaseContactKey: integer
(int64)
Read Only:
true
The unique identifier of the case notice contact. -
CaseContacts: array
Case Contacts
Title:
Case Contacts
The case contact resource is used to view the contact information of a citation notice. Citation notices are used in Code Enforcement cases. -
CaseId: string
Read Only:
true
Maximum Length:50
The unique identifier of the case. -
CaseKey: integer
(int64)
Read Only:
true
The unique identifier of the case. -
CaseNoticeId: string
Title:
Notice ID
Read Only:true
Maximum Length:50
The unique identifier of the case notice. -
CaseNoticeKey: integer
(int64)
Read Only:
true
The unique identifier of the case notice. -
CaseStatus: string
Title:
Case Status
Read Only:true
Maximum Length:15
The status of the case. -
CitationDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the case citation. -
CitationDueDate: string
(date)
Title:
Due Date
Read Only:true
The due date for the case 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. -
Comments: string
Title:
Comments
Read Only:true
Maximum Length:1000
The comments entered for the case notice. -
ComplianceDueDate: string
(date)
Read Only:
true
The compliance due date for the case. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
IssueSubtype: string
Read Only:
true
Maximum Length:100
The subtype of the issue for the case. -
IssueSubtypeId: string
Read Only:
true
Maximum Length:50
The identifier of the issue subtype for the case notice. -
IssueTypeId: string
Read Only:
true
Maximum Length:50
The identifier of the issue type for the case notice. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoticeSource: string
Title:
Type
Read Only:true
Maximum Length:15
Default Value:ORA_ADHOC
The source of the case notice. -
NoticeStatus: string
Title:
Status
Read Only:true
Maximum Length:15
Default Value:ORA_PEND
The status of the case notice. -
NoticeStatusText: string
Read Only:
true
Maximum Length:255
The notice status text of the citation notice. -
NoticeTypeCode: string
Read Only:
true
Maximum Length:100
The notice type code for the case notice. -
NoticeTypeName: string
Title:
Name
Read Only:true
Maximum Length:200
The name of notice type. -
OutputFormat: string
Read Only:
true
Maximum Length:20
Default Value:ORA_PDF
The output format of the notice generated. -
ProcessInstanceId: string
Read Only:
true
Maximum Length:255
The process instance identifier of the workflow associated with the case. -
PropertyAddress1: string
Read Only:
true
Maximum Length:240
The first line for the property address related to the case. -
PropertyAddress2: string
Read Only:
true
Maximum Length:240
The second line for the property address related to the case. -
PropertyAddress3: string
Read Only:
true
Maximum Length:240
The third line for the property address related to the case. -
PropertyAddress4: string
Read Only:
true
Maximum Length:240
The fourth line for the property address related to the case. -
PropertyAddressId: integer
(int64)
Read Only:
true
The unique identifier of the property address for the case. -
PropertyCity: string
Read Only:
true
Maximum Length:60
The city in which the property related to the case is located. -
PropertyCoordinateX: number
Read Only:
true
The latitude of the property related to the case. -
PropertyCoordinateY: number
Read Only:
true
The longitude of the property related to the case. -
PropertyCountry: string
Read Only:
true
Maximum Length:3
The country in which the property related to the case is located. -
PropertyCounty: string
Read Only:
true
Maximum Length:60
The county in which the property related to the case is located. -
PropertyParcelId: integer
(int64)
Read Only:
true
The unique identifier of the property address related to the case. -
PropertyPostalCode: string
Read Only:
true
Maximum Length:60
The postal code of the property address related to the case. -
PropertyPostalPluscode: string
Read Only:
true
Maximum Length:10
The postal plus code of the property address related to the case. -
PropertyProvince: string
Read Only:
true
Maximum Length:60
The province in which the property related to the case is located. -
PropertyState: string
Read Only:
true
Maximum Length:60
The state in which the property related to the case is located. -
ReceivedDate: string
(date-time)
Title:
Received Date
Read Only:true
The date on which the notice was received. -
ResponsiblePartyAddress1: string
Read Only:
true
Maximum Length:240
The responsible party's address 1. -
ResponsiblePartyAddress2: string
Read Only:
true
Maximum Length:240
The responsible party's address 2. -
ResponsiblePartyAddress3: string
Read Only:
true
Maximum Length:240
The responsible party's address 3. -
ResponsiblePartyAddress4: string
Read Only:
true
Maximum Length:240
The responsible party's address 4. -
ResponsiblePartyCity: string
Read Only:
true
Maximum Length:60
The responsible party's city. -
ResponsiblePartyCountry: string
Read Only:
true
Maximum Length:3
The responsible party's country. -
ResponsiblePartyDisplayname: string
Read Only:
true
Maximum Length:255
The display name of the responsible party. -
ResponsiblePartyFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The responsible party first name. -
ResponsiblePartyLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the responsible party. -
ResponsiblePartyPostal: string
Read Only:
true
Maximum Length:60
The responsible party's postal code. -
ResponsiblePartyState: string
Read Only:
true
Maximum Length:60
The responsible party's state. -
ReviewerId: integer
(int64)
Read Only:
true
The code technician identifier for the case. -
Sequence: integer
(int32)
Read Only:
true
Default Value:0
The sequence of the case notice. -
ShippedBy: string
Title:
Carrier Name
Read Only:true
Maximum Length:500
The name of the shipping carrier that is delivering the case notice. -
ShippedDate: string
(date-time)
Title:
Sent Date
Read Only:true
The date on which the case notice was shipped. -
TrackingId: string
Title:
Tracking Number
Read Only:true
Maximum Length:500
The tracking identifier of the shipping carrier delivering the case notice.
Nested Schema : Case Contacts
Type:
array
Title:
Case Contacts
The case contact resource is used to view the contact information of a citation notice. Citation notices are used in Code Enforcement cases.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorListCitationNotices-CaseContacts-item-response
Type:
Show Source
object
-
AccessApprovedBy: string
Maximum Length:
64
The approver for the case access request. -
AccessApprovedByUser: string
Read Only:
true
The approver user name for the case access request. -
AccessApprovedDate: string
(date-time)
The approval date for the case access request.
-
AccessComments: string
Maximum Length:
1000
The access comments provided by the case contact. -
AccessStatus: string
Title:
Online Access Status
Maximum Length:30
Default Value:ORA_NA
The access status of the case contact. -
Address1: string
Maximum Length:
240
The first line for the contact address related to the case. -
Address2: string
Maximum Length:
240
The second line for the contact address related to the case. -
Address3: string
Maximum Length:
240
The third line for the contact address related to the case. -
Address4: string
Maximum Length:
240
The fourth line for the contact address related to the case. -
AgencyComments: string
Maximum Length:
1000
The comments by the agency staff. -
BusinessName: string
Maximum Length:
254
The business name of the case contact. -
CaseContactKey: integer
(int64)
The unique identifier of the case contact.
-
CaseContactPuid: string
Maximum Length:
480
The public unique identifier of the migrated case contact record. -
CaseKey: integer
(int64)
The unique identifier of the case.
-
CasePuid: string
Maximum Length:
480
The public unique identifier of the migrated case record. -
City: string
Maximum Length:
60
The city of the case contact. -
ClaimantContactType: string
Read Only:
true
Maximum Length:255
The meaning of the contact type code. -
ClaimantUserName: string
Read Only:
true
The username of the case claimant. -
ContactAccessStatus: string
Read Only:
true
Maximum Length:255
The meaning of the access status code. -
ContactFullname: string
Read Only:
true
Maximum Length:255
The full name of the responsible party. -
ContactPartyId: integer
(int64)
The party identifier of the case contact.
-
ContactPartyPuid: string
The party identifier of the case contact.
-
ContactType: string
Title:
Type
Maximum Length:15
Default Value:ORA_OWNER
The type of case contact. -
Country: string
Maximum Length:
3
The country of the case contact. -
County: string
Maximum Length:
60
The county of the case contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
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. -
EmailAddress: string
Maximum Length:
254
The email address of the case contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
LastUpdatedByUser: string
Read Only:
true
The name of the user who last updated the entry. -
LegacyApproverName: string
Maximum Length:
100
The legacy system approver user name for migrated data. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of the case contact. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The last name of the case contact. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the case contact. -
PersonNameSuffix: string
Title:
Name Suffix
Maximum Length:30
The suffix for case contact name. -
PersonTitle: string
Title:
Title
Maximum Length:60
The title for the case contact name. -
PhoneAreaCode: string
Maximum Length:
10
The responsible party phone area code. -
PhoneCountryCode: string
Maximum Length:
10
The responsible party phone country code. -
PhoneExtension: string
Maximum Length:
20
The responsible party phone extension code. -
PhoneNumber: string
Maximum Length:
100
The phone number of the case contact. -
PostalCode: string
Maximum Length:
60
The postal code of the case contact address. -
PostalPlusCode: string
Maximum Length:
10
The postal plus code of the case contact address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:true
Indicates if the contact is the primary contact for the case. -
Province: string
Maximum Length:
60
The province of the case contact. -
State: string
Maximum Length:
60
The state of the case contact. -
Status: string
Maximum Length:
1
The approval date for the case access request. -
UserEmail: string
Maximum Length:
254
The email address of the access request user. -
UserFirstName: string
Maximum Length:
150
The first name of the case claimant. -
UserLastName: string
Maximum Length:
150
The last name of the case claimant. -
UserPhoneAreaCode: string
Maximum Length:
10
The phone area code of the access request user. -
UserPhoneCountryCode: string
Maximum Length:
10
The phone country code of the access request user. -
UserPhoneExtension: string
Maximum Length:
20
The phone extension of the access request user. -
UserPhoneNumber: string
Maximum Length:
100
The phone number of the access request user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.