1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Projects
  4. Project Permit Lists

Get all permits assigned to a project

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitLists

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 project permit that matches the specified primary key criteria.
      Finder Variables:
      • AgencyId; integer; The identifier of the agency to which the project belongs.
      • ProjectCode; string; The unique identifier of the project.
      • RecordKey; integer; The unique identifier of the record.
    • simpleSearchFinder: Finds the project permit that matches the specified keyword.
      Finder Variables:
      • value; string; The keyword that is used to find a project permit based on the project code, record ID, record type, applicant, or the creation details of the record.
  • 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:
    • Address1; string; The first line of the address.
    • Address2; string; The second line of the address, if available.
    • Address3; string; The third line of the address, if available.
    • Address4; string; The forth line of the address, if available.
    • AgencyId; integer; The unique identifier of the public sector agency.
    • Applicant; integer; The party identifier of the person applying for the permit, license, zoning, and others.
    • ApplicantBizProfileId; integer; The profile identifier of the business of the applicant.
    • ApplicantCriteria; string; The party identifier of the person applying for the permit, license, zoning, and others.
    • ApplicantProfileId; integer; The profile identifier of the applicant.
    • City; string; The name of the city where the applicant lives.
    • Classification; string; The classification of the record type.
    • CreateByName; string; The name of the user who created the record.
    • CreatedBy; string; The name of the user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • CreationDateCriteria; string; The date and time when the record was created.
    • CurrencyCode; string; The currency code that is used to complete any payments.
    • Description; string; The description of the record.
    • EmailAddress1; string; The email address of the applicant.
    • ExpirationDate; string; The date and time when the record expires.
    • ExpirationDateCriteria; string; The date and time when the record expires.
    • IssueDate; string; The date and time when the application was issued.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdateDateCriteria; string; The date when the record was last updated.
    • LastUpdatedBy; string; The name of the user who last updated the record.
    • LnpRecordId; string; The identifier of the application record. The value is generated based on the auto number rule configured for the record type.
    • LnpRecordKey; integer; The unique identifier of the record.
    • ParcelIdEntered; string; The entered parcel identifier, based on the local maps.
    • PersonName; string; The name of the person completing the application process.
    • PhoneNumber; string; The phone number of the applicant.
    • ProjectCode; string; The unique identifier of the project.
    • ProjectKey; integer; The unique identifier of the project.
    • RecordKey; integer; The unique identifier of the record.
    • RecordType; string; The description of the record type code.
    • RecordTypeCode; string; The alphanumeric code of the record type.
    • RecordTypeId; string; The unique key identifier of the record type for the record.
    • State; string; The name of the state where the applicant lives.
    • Status; string; The status of the record.
    • Subclassification; string; The qualifier that is used to determine the type of application, which can be a Planning and Zoning application or a Pre-application.
    • SubmitDate; string; The date and time when the record was submitted.
    • SubmittedBy; string; The identifier of the user who submits the application.
    • Total; number; The total amount of fees for the record.
    • TotalCriteria; string; The total amount of fees for the record.
    • TotalDue; number; The amount of fees that is currently due for the record.
    • TotalDueCriteria; string; The amount of fees that is currently due for the record.
    • TotalPaid; number; The amount paid towards the total fees for the record.
  • 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 : publicSectorProjectPermitLists
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorProjectPermitLists-item-response
Type: object
Show Source
Back to Top