1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Code Enforcement
  4. List Violation Notices

Get all violation notices

get

/fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices

Request

Query Parameters
  • 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).
  • 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
  • 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; Finds the in-progress case notice that matches the specified search value.
    • OpenNoticesFinder: Finds the open case notice that matches the specified search criteria.
      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 unassigned case notice that matches the specified search value.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 of 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 identifier 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.
    • Comments; string; The comments entered about the case notice.
    • ComplianceDueDate; string; The compliance due date of case.
    • CreationDate; string; The date and time when the row was created.
    • IssueSubtype; string; The issue subtype of the case.
    • IssueSubtypeId; string; The issue subtype identifier of the case notice.
    • IssueTypeId; string; The issue type identifier of 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 violation notice.
    • NoticeTypeCode; string; The notice type identifier of 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 address of the property related to the case.
    • PropertyAddress2; string; The second line for the address of the property related to the case.
    • PropertyAddress3; string; The third line for the address of the property related to the case.
    • PropertyAddress4; string; The fourth line for the address of the property related to the case.
    • PropertyAddressId; integer; The unique identifier of the property address related to 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 for the property address of the case.
    • PropertyPostalCode; string; The postal code of the property related to the case.
    • PropertyPostalPluscode; string; The postal plus code of the property 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 responsible party's display name.
    • ResponsiblePartyFirstName; string; The responsible party's first name.
    • ResponsiblePartyLastName; string; The responsible party's last name.
    • ResponsiblePartyPostal; string; The responsible party's postal code.
    • ResponsiblePartyState; string; The responsible party's state.
    • ReviewerId; integer; The code technician identifier of 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; Date on which the notice was shipped.
    • TrackingId; string; The tracking identifier of the shipping carrier delivering the case notice.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorListViolationNotices
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorListViolationNotices-item-response
Type: object
Show Source
Nested Schema : Case Contacts
Type: array
Title: Case Contacts
The case contact resource is used to view the contact details of a violation notice. Violation notices are used in Code Enforcement cases.
Show Source
Nested Schema : publicSectorListViolationNotices-CaseContacts-item-response
Type: object
Show Source
Back to Top