Get all permits
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressSearchQueries
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:- PrimaryKey: Finds a permit using the primary key criteria. Finder Variables:
- AddressKey; integer; The unique identifier for a parcel address.
- LnpRecordKey; integer; The unique identifier for a record. The record can be for a permit, business license, professional license, or planning and zoning, which is determined by the classification.
- ParcelKey; integer; The unique identifier for a permit parcel.
- PrimaryKey: Finds a permit using the primary key criteria. 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 : publicSectorRecordParcelAddressSearchQueries
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 : publicSectorRecordParcelAddressSearchQueries-item
Type:
Show Source
object
-
AddressKey(optional):
integer(int64)
The unique identifier for the parcel address associated with a parcel.
-
Applicant(optional):
integer(int64)
The ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
-
ApplicantBizProfileId(optional):
integer(int64)
The unique identifier of the applicant business profile when the applicant is a business entity.
-
ApplicantProfileId(optional):
integer(int64)
The unique identifier of the applicant user profile.
-
City(optional):
string
Maximum Length:
60
The city name in the parcel address. -
Classification(optional):
string
Maximum Length:
3
The classification of the permit type. -
Description(optional):
string
Maximum Length:
1000
The record description. -
DistrictName(optional):
string
Maximum Length:
50
The district name of the parcel. -
IssueDate(optional):
string(date-time)
The date on which the permit was issued.
-
Jurisdiction(optional):
string
Maximum Length:
50
The name of the city, if incorporated, or the name of the county, if unincorporated. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Maximum Length:
50
The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
Paddressfour(optional):
string
Maximum Length:
240
The fourth parcel address, if present. -
Paddressone(optional):
string
Maximum Length:
240
The first or main parcel address. -
Paddressthree(optional):
string
Maximum Length:
240
The third parcel address, if present. -
Paddresstwo(optional):
string
Maximum Length:
240
The second parcel address, if present. -
PaPrimary(optional):
string
Maximum Length:
1
Indicates flag value for the primary parcel address. -
ParcelFullAddress(optional):
string
Maximum Length:
966
The full address of the parcel. -
ParcelId(optional):
integer(int64)
The identifier of the record parcel.
-
ParcelIdEntered(optional):
string
Maximum Length:
30
The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey(optional):
integer(int64)
The unique identifier for the parcel associated with a parcel address.
-
ParcelPrimary(optional):
string
Maximum Length:
1
Indicates flag value for the primary parcel. -
PersonFirstName(optional):
string
Maximum Length:
150
The first name of the applicant. -
PersonLastName(optional):
string
Maximum Length:
150
The last name of the applicant. -
PersonMiddleName(optional):
string
Maximum Length:
60
The middle name of the applicant. -
PersonName(optional):
string
Maximum Length:
450
The full name of the applicant. -
PersonNameSuffix(optional):
string
Maximum Length:
30
The suffix of the applicant name, such as Junior or Senior. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
The salutation for the applicant, such as Mr. or Mrs. -
PersonTitle(optional):
string
Maximum Length:
60
The title of the applicant. -
PostalCode(optional):
string
Maximum Length:
60
The postal code in the parcel address. -
PrimaryAddress(optional):
string
Maximum Length:
966
The primary address of the parcel. -
ProjectKey(optional):
integer(int64)
The project to which this permit belongs.
-
PropertyDescription(optional):
string
Maximum Length:
240
The property description. -
RecordType(optional):
string
Maximum Length:
100
The user-friendly name for the permit type. -
RecordTypeCode(optional):
string
Maximum Length:
20
The record type code of the parcel address. -
RenewalDate(optional):
string(date-time)
The date on which the permit was renewed.
-
State(optional):
string
Maximum Length:
60
The state name in the parcel address. -
Status(optional):
string
Maximum Length:
15
The status of the parcel address. -
StreetName(optional):
string
Maximum Length:
240
The street name in the parcel adress. -
StreetNumber(optional):
string
Maximum Length:
20
The street number in the parcel adress. -
SubmitDate(optional):
string(date-time)
The date on which the application was submitted.
-
SystemStatus(optional):
string
Maximum Length:
15
The predefined system status to which the record status maps. -
TransPrimary(optional):
string
Maximum Length:
1
Indicates flag value for the transaction primary. -
UnitNumber(optional):
string
Maximum Length:
30
The unit number in the parcel address.
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.