1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. List of Values
  4. Inspection Console Permits

Get all inspection-ready permits

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionConsolePermits

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 the permit that matches the primary key criteria specified.
      Finder Variables:
      • LnpRecordId; string; The unique identifier of the application record.
      • LnpRecordKey; integer; The unique identifier of the record associated with the permit.
  • 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:
    • Applicant; integer; The party ID of the person applying for the application.
    • ApplicantUsername; string; The permit applicant user ID.
    • BusDbaBusinessName; string; The doing business as (DBA) name for the business entity.
    • Classification; string; The classification of the permit type.
    • Description; string; The description of the application record.
    • EmailAddress1; string; The primary contact's email address.
    • FormattedAddr; string; The primary address and city of the primary parcel or address associated with the permit.
    • InspectionGroup; string; The unique alphanumeric code or short name for the inspection group associated with the permit type.
    • LnpRecordId; string; The unique identifier of the application record.
    • LnpRecordKey; integer; The unique identifier of the record associated with the permit.
    • PersonName; string; The display name of the applicant.
    • PhoneAreaCode; string; The primary contact's phone area code.
    • PhoneCountryCode; string; The primary contact's email address.
    • PhoneExtension; string; The primary contact's phone extension.
    • PhoneNumber; string; The primary contact's phone number.
    • PrimaryFlag; string; Indicates whether the record is a primary application that has one or more subapplications. When a permit is created, the default value is N or no.
    • PrimaryRecordKey; integer; The unique identifier of the primary record.
    • RecordType; string; The unique alphanumeric code or short name for the permit type.
    • RecordTypeCode; string; The description of the permit type.
    • Status; string; The status of the application record.
    • SubapplicationFlag; string; Indicates whether the record is a subapplication or child of a primary application. When a permit is created, the default value is N or no.
    • Subclassification; string; The subclassification for the transaction type, which indicates that the preapplication process is included in addition to the hearing process.
    • SystemStatus; string; The predefined system status to which the record status maps.
    • VersionType; string; The version of the permit. Values are origination, amendment, and renewal.
  • 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 : publicSectorInspectionConsolePermits
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorInspectionConsolePermits-item-response
Type: object
Show Source
Back to Top