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

Get code enforcement statuses

get

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses

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:

    • PrimaryKey: Finds statuses that matches the specified primary key criteria.
      Finder Variables:
      • AgencyId; integer; The unique identifier for an agency.
      • Classification; string; The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection.
      • Status; string; The unique identifier of a code enforcement status.
    • caseFinder: Finds statuses that are associated with cases.
      Finder Variables:
      • incidentFinder: Finds statuses that are associated with incidents.
        Finder Variables:
        • inspectionFinder: Finds statuses that are associated with inspections.
          Finder Variables:
          • simpleSearchFinder: Finds the status based on the search criteria entered.
            Finder Variables:
            • value; string; Finds the status based on the search value entered.
        • 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 unique identifier for an agency.
          • Classification; string; The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection.
          • CreatedBy; string; The user who created the code enforcement status.
          • CreationDate; string; The date and time that the code enforcement status was created.
          • DeletedFlag; string; Indicates whether the record is deleted.
          • EnabledFlag; string; Indicates whether the record is enabled.
          • LastUpdateDate; string; The date and time that the code enforcement status was last updated.
          • LastUpdateLogin; string; The session login associated with the user who last updated the code enforcement status.
          • LastUpdatedBy; string; The user who last updated the code enforcement status.
          • ObjectVersionNumber; integer; Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
          • SeedDataLock; integer; Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
          • Status; string; The unique identifier of the code enforcement status code.
          • StatusName; string; The description of the code enforcement status code.
          • SystemStatus; string; The delivered value of a code enforcement status.
          • SystemUse; string; Indicates whether workflow integration is active. When workflow integration is active, the workflow system makes all status changes, and users are not permitted to manually update the status.
        • 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 : publicSectorCodeEnforcementStatuses
        Type: object
        Show Source
        Nested Schema : Items
        Type: array
        Title: Items
        The items in the collection.
        Show Source
        Nested Schema : publicSectorCodeEnforcementStatuses-item-response
        Type: object
        Show Source
        • The unique identifier for an agency.
        • Maximum Length: 15
          The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection.
        • Read Only: true
          Maximum Length: 64
          The user who created the code enforcement status.
        • Read Only: true
          The date and time that the code enforcement status was created.
        • Maximum Length: 1
          Indicates whether the record is deleted.
        • Title: Enabled
          Maximum Length: 1
          Indicates whether the record is enabled.
        • Read Only: true
          The date and time that the code enforcement status was last updated.
        • Read Only: true
          Maximum Length: 64
          The user who last updated the code enforcement status.
        • Read Only: true
          Maximum Length: 32
          The session login associated with the user who last updated the code enforcement status.
        • Links
        • Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
        • Default Value: 0
          Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
        • Title: Status
          Maximum Length: 15
          The unique identifier of the code enforcement status code.
        • Title: Description
          Maximum Length: 30
          The description of the code enforcement status code.
        • Title: System Status
          Maximum Length: 15
          The delivered value of a code enforcement status.
        • Maximum Length: 1
          Indicates whether workflow integration is active. When workflow integration is active, the workflow system makes all status changes, and users are not permitted to manually update the status.
        Back to Top