Get a permit assigned to a project
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjectPermitLists/{publicSectorProjectPermitListsUniqID}
Request
Path Parameters
-
publicSectorProjectPermitListsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, ProjectCode and RecordKey ---for the Project Permit Lists resource and used to uniquely identify an instance of Project Permit Lists. The client should not generate the hash key value. Instead, the client should query on the Project Permit Lists collection resource with a filter on the primary key values in order to navigate to a specific instance of Project Permit Lists.
For example: publicSectorProjectPermitLists?q=AgencyId=<value1>;ProjectCode=<value2>;RecordKey=<value3>
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorProjectPermitLists-item
Type:
Show Source
object-
Address1(optional):
string
Title:
Address Line 1Maximum Length:240The first line of the address. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second line of the address, if available. -
Address3(optional):
string
Maximum Length:
240The third line of the address, if available. -
Address4(optional):
string
Maximum Length:
240The forth line of the address, if available. -
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
Applicant(optional):
integer(int64)
Title:
ApplicantThe 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:
40The 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:
60The name of the city where the applicant lives. -
Classification(optional):
string
Title:
ClassificationMaximum Length:3The classification of the record type. -
CreatedBy(optional):
string
Maximum Length:
64The 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:
16The date and time when the record was created. -
CurrencyCode(optional):
string
Title:
Currency CodeMaximum Length:3The currency code that is used to complete any payments. -
Description(optional):
string
Title:
DescriptionMaximum Length:300The description of the record. -
EmailAddress1(optional):
string
Maximum Length:
320The email address of the applicant. -
ExpirationDate(optional):
string(date-time)
The date and time when the record expires.
-
ExpirationDateCriteria(optional):
string
Maximum Length:
16The 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:
16The date when the record was last updated. -
LastUpdatedBy(optional):
string
Maximum Length:
64The name of the user who last updated the record. -
links(optional):
array Items
Title:
ItemsLink Relations -
LnpRecordId(optional):
string
Title:
Permit IDMaximum Length:50The 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:
30The entered parcel identifier, based on the local maps. -
PersonName(optional):
string
Title:
NameMaximum Length:450The name of the person completing the application process. -
PhoneNumber(optional):
string
Title:
Contact InformationMaximum Length:40The phone number of the applicant. -
ProjectCode(optional):
string
Maximum Length:
255The unique identifier of the project. -
ProjectKey(optional):
integer(int64)
The unique identifier of the project.
-
RecordKey(optional):
integer(int64)
Title:
Permit NumberThe unique identifier of the record. -
RecordType(optional):
string
Title:
Permit TypeMaximum Length:100The description of the record type code. -
RecordTypeCode(optional):
string
Title:
Permit TypeMaximum Length:20The alphanumeric code of the record type. -
RecordTypeId(optional):
string
Title:
Record Type IDMaximum Length:30The unique key identifier of the record type for the record. -
State(optional):
string
Maximum Length:
60The name of the state where the applicant lives. -
Status(optional):
string
Title:
StatusMaximum Length:15The status of the record. -
Subclassification(optional):
string
Maximum Length:
10The 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:
64The identifier of the user who submits the application. -
Total(optional):
number
Title:
Total FeeThe total amount of fees for the record. -
TotalCriteria(optional):
string
Maximum Length:
40The total amount of fees for the record. -
TotalDue(optional):
number
Title:
BalanceThe amount of fees that is currently due for the record. -
TotalDueCriteria(optional):
string
Maximum Length:
40The amount of fees that is currently due for the record. -
TotalPaid(optional):
number
Title:
Total PaymentThe amount paid towards the total fees for the record.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.