Get all permits assigned to a project
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitLists
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:- 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.
- 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:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorProjectPermitLists
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorProjectPermitLists-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Address Line 1
Maximum Length:240
The first line of the address. -
Address2(optional):
string
Title:
Address Line 2
Maximum Length:240
The second line of the address, if available. -
Address3(optional):
string
Maximum Length:
240
The third line of the address, if available. -
Address4(optional):
string
Maximum Length:
240
The forth line of the address, if available. -
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
Applicant(optional):
integer(int64)
Title:
Applicant
The party identifier of the person applying for the permit, license, zoning, and others. -
ApplicantBizProfileId(optional):
integer(int64)
The profile identifier of the business of the applicant.
-
ApplicantCriteria(optional):
string
Maximum Length:
40
The party identifier of the person applying for the permit, license, zoning, and others. -
ApplicantProfileId(optional):
integer(int64)
The profile identifier of the applicant.
-
City(optional):
string
Maximum Length:
60
The name of the city where the applicant lives. -
Classification(optional):
string
Title:
Classification
Maximum Length:3
The classification of the record type. -
CreatedBy(optional):
string
Maximum Length:
64
The name of the user who created the record. -
CreationDate(optional):
string(date-time)
The date and time when the record was created.
-
CreationDateCriteria(optional):
string
Maximum Length:
16
The date and time when the record was created. -
CurrencyCode(optional):
string
Title:
Currency Code
Maximum Length:3
The currency code that is used to complete any payments. -
Description(optional):
string
Title:
Description
Maximum Length:300
The description of the record. -
EmailAddress1(optional):
string
Maximum Length:
320
The email address of the applicant. -
ExpirationDate(optional):
string(date-time)
The date and time when the record expires.
-
ExpirationDateCriteria(optional):
string
Maximum Length:
16
The date and time when the record expires. -
IssueDate(optional):
string(date-time)
The date and time when the application was issued.
-
LastUpdateDate(optional):
string(date-time)
The date when the record was last updated.
-
LastUpdateDateCriteria(optional):
string
Maximum Length:
16
The date when the record was last updated. -
LastUpdatedBy(optional):
string
Maximum Length:
64
The name of the user who last updated the record. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit ID
Maximum Length:50
The identifier of the application record. The value is generated based on the auto number rule configured for the record type. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record.
-
ParcelIdEntered(optional):
string
Maximum Length:
30
The entered parcel identifier, based on the local maps. -
PersonName(optional):
string
Title:
Name
Maximum Length:450
The name of the person completing the application process. -
PhoneNumber(optional):
string
Title:
Contact Information
Maximum Length:40
The phone number of the applicant. -
ProjectCode(optional):
string
Maximum Length:
255
The unique identifier of the project. -
ProjectKey(optional):
integer(int64)
The unique identifier of the project.
-
RecordKey(optional):
integer(int64)
Title:
Permit Number
The unique identifier of the record. -
RecordType(optional):
string
Title:
Permit Type
Maximum Length:100
The description of the record type code. -
RecordTypeCode(optional):
string
Title:
Permit Type
Maximum Length:20
The alphanumeric code of the record type. -
RecordTypeId(optional):
string
Title:
Record Type ID
Maximum Length:30
The unique key identifier of the record type for the record. -
State(optional):
string
Maximum Length:
60
The name of the state where the applicant lives. -
Status(optional):
string
Title:
Status
Maximum Length:15
The status of the record. -
Subclassification(optional):
string
Maximum Length:
10
The qualifier that is used to determine the type of application, which can be a Planning and Zoning application or a Pre-application. -
SubmitDate(optional):
string(date-time)
The date and time when the record was submitted.
-
SubmittedBy(optional):
string
Maximum Length:
64
The identifier of the user who submits the application. -
Total(optional):
number
Title:
Total Fee
The total amount of fees for the record. -
TotalCriteria(optional):
string
Maximum Length:
40
The total amount of fees for the record. -
TotalDue(optional):
number
Title:
Balance
The amount of fees that is currently due for the record. -
TotalDueCriteria(optional):
string
Maximum Length:
40
The amount of fees that is currently due for the record. -
TotalPaid(optional):
number
Title:
Total Payment
The amount paid towards the total fees for the record.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.