Get all permit application contact items
get
/fscmRestApi/resources/11.13.18.05/publicSectorPermitApplicationContacts
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 the application contacts data that match the specified record key. Finder Variables:
- ContactKey; integer; The unique identifier for the contact key.
- LnpRecordKey; integer; The unique identifier for the record key.
- PrimaryKey: Finds the application contacts data that match the specified record key. 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 : publicSectorPermitApplicationContacts
Type:
Show Source
object-
count(optional):
integer
Title:
CountThe number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMoreIndicates 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:
ItemsThe items in the collection. -
limit(optional):
integer
Title:
LimitThe actual paging size used by the server. -
links(optional):
array Items
Title:
ItemsThe link relations associated with the resource instance. -
offset(optional):
integer
Title:
OffsetThe offset value used in the current page.
Nested Schema : Items
Type:
arrayTitle:
ItemsThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPermitApplicationContacts-item
Type:
Show Source
object-
AcceptanceDate(optional):
string(date-time)
Title:
Acceptance DateIdentifies the accepted date for the permit application. -
AddressKey(optional):
integer(int64)
The parcel address key.
-
AgencyId(optional):
integer(int32)
The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
-
Applicant(optional):
integer(int64)
The party ID of the permit applicant.
-
Applicantaddressone(optional):
string
Title:
Applicant Address Line 1Maximum Length:240The first line of the permit applicant address. -
Applicantaddresstwo(optional):
string
Title:
Applicant Address Line 2Maximum Length:240The second line of the permit applicant address. -
Applicantcity(optional):
string
Title:
Applicant CityMaximum Length:60The city in the permit applicant address. -
Applicantcountry(optional):
string
Title:
Applicant CountryMaximum Length:3The country in the permit applicant address. -
Applicantcounty(optional):
string
Title:
Applicant CountyMaximum Length:60The county in the permit applicant address. -
Applicantemailaddressone(optional):
string
Title:
Applicant Email 1Maximum Length:320The first email address of the permit applicant. -
Applicantemailaddresstwo(optional):
string
Title:
Applicant Email 2Maximum Length:320The second email address of the permit applicant. -
Applicantpersonname(optional):
string
Title:
Applicant Full NameMaximum Length:450The permit applicant's name. -
Applicantphone(optional):
string
Title:
Applicant PhoneMaximum Length:60The full phone number including the phone country code, area code, and phone number for the applicant.. -
Applicantphoneareacode(optional):
string
Maximum Length:
10The area code in the phone number of the permit applicant. -
Applicantphonecountrycode(optional):
string
Maximum Length:
10The country code in the phone number of the permit applicant. -
Applicantphoneextension(optional):
string
Title:
Applicant Phone ExtensionMaximum Length:20The phone number extension for the permit applicant. -
Applicantphonenumber(optional):
string
Maximum Length:
40The permit applicant's phone number. -
Applicantpostalcode(optional):
string
Title:
Applicant Postal CodeMaximum Length:60The postal code in the permit applicant address. -
ApplicantProfileId(optional):
integer(int64)
The user profile of the applicant.
-
Applicantprovince(optional):
string
Title:
Applicant ProvinceMaximum Length:60The province in the permit applicant address. -
Applicantstate(optional):
string
Title:
Applicant StateMaximum Length:60The state in the permit applicant address. -
ApplicantUserId(optional):
string
Title:
Applicant User IDThe user ID of the permit applicant. -
ApplicationAccess(optional):
string
Title:
Permit AccessIndicates the application access for the contact person. -
Classification(optional):
string
Title:
ClassificationMaximum Length:80The record classification. The classifications can be permit. -
Contactactive(optional):
string
Title:
Contact Active StatusMaximum Length:1The contact status of the person. -
Contactaddressone(optional):
string
Title:
Contact Address Line 1Maximum Length:240The first address line for the contact person. -
Contactaddresstwo(optional):
string
Title:
Contact Address Line 2Maximum Length:240The second address line for the contact person. -
Contactaltphone(optional):
string
Title:
Contact Alternate PhoneMaximum Length:60The alternate phone number with country code for the contact person. -
Contactaltphoneareacode(optional):
string
Maximum Length:
10The alternate phone area code for the contact person. -
Contactaltphonecountrycode(optional):
string
Maximum Length:
10The alternate phone country code for the contact person. -
Contactaltphonenumber(optional):
string
Maximum Length:
40The alternate phone number for the contact person. -
ContactBizPartyId(optional):
integer(int64)
The contact list business party ID.
-
Contactbusinessname(optional):
string
Title:
Contact Business NameMaximum Length:360The contact's business name. -
Contactcity(optional):
string
Title:
Contact CityMaximum Length:60The city for the contact person's address. -
Contactcountry(optional):
string
Title:
Contact CountryMaximum Length:3The country for the contact person. -
Contactcounty(optional):
string
Title:
Contact CountyMaximum Length:60The county for the contact person's address. -
Contactcreationdate(optional):
string(date-time)
Title:
Contact Creation DateThe contact creation date for the person. -
Contactemailaddressone(optional):
string
Title:
Contact EmailMaximum Length:320The email address information for the contact person. -
Contactfirstname(optional):
string
Title:
Contact First NameMaximum Length:150The contact's first name. -
Contactfullname(optional):
string
Title:
Contact Full NameMaximum Length:450The contact's full name. -
ContactId(optional):
integer(int64)
The unique identifier of the contact.
-
ContactKey(optional):
integer(int64)
The unique identifier for the contact.
-
Contactlastname(optional):
string
Title:
Contact Last NameMaximum Length:150The contact's last name. -
Contactmiddlename(optional):
string
Title:
Contact Middle NameMaximum Length:60The contact's middle name. -
ContactPartyId(optional):
integer(int64)
The contact list party ID.
-
Contactphone(optional):
string
Title:
Contact PhoneMaximum Length:60The full phone number including the phone country code, area code, and phone number for the contact person. -
Contactphoneareacode(optional):
string
Maximum Length:
10The phone area code for the contact person. -
Contactphonecountrycode(optional):
string
Maximum Length:
10The phone country code for the contact person. -
Contactphoneextension(optional):
string
Title:
Contact Phone ExtensionMaximum Length:20The phone extension for the contact person. -
Contactphonenumber(optional):
string
Maximum Length:
40The phone number for the contact person. -
Contactpostalcode(optional):
string
Title:
Contact Postal CodeMaximum Length:60The postal code for the contact person's address. -
ContactProfileId(optional):
integer(int64)
The profile ID of the contact.
-
Contactstate(optional):
string
Title:
Contact StateMaximum Length:60The state for the contact person's address. -
Contacttype(optional):
string
Title:
Contact TypeMaximum Length:30Identifies the contact type of the primary contact of the permit application. -
Contactuserid(optional):
string
Title:
Contact User IDMaximum Length:100The contact user ID. -
CreationDate(optional):
string(date-time)
Title:
Creation DateIdentifies the date on which the permit application was created. -
IssueDate(optional):
string(date-time)
Title:
Issue DateThe date the permit was issued. -
links(optional):
array Items
Title:
ItemsLink Relations -
LnpRecordId(optional):
string
Title:
Record IDMaximum Length:50The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for the record.
-
OrganizationName(optional):
string
Title:
Organization NameMaximum Length:360The business name of the applicant. For example, a contractor enters his or her contracting business name. -
Owner(optional):
string
Title:
Property Owner NameMaximum Length:150The primary or only owner of the parcel or property. -
Owneremailid(optional):
string
Title:
Property Owner EmailMaximum Length:50The parcel owner email address. -
OwnerId(optional):
integer(int64)
The owner ID of the record parcel owner.
-
OwnerKey(optional):
integer(int64)
The owner key of the record parcel owner.
-
Parceladdressone(optional):
string
Title:
Property Address Line 1Maximum Length:240The first line of the parcel or property address. -
Parceladdresstwo(optional):
string
Title:
Property Address Line 2Maximum Length:240The second line of the parcel or property address. -
Parcelcity(optional):
string
Title:
Property CityMaximum Length:60The city in the parcel or property address. -
Parcelcountry(optional):
string
Title:
Property CountryMaximum Length:60The country in the parcel or property address. -
Parcelcounty(optional):
string
Title:
Property CountyMaximum Length:60The county in the parcel or property address. -
ParcelId(optional):
integer(int64)
Title:
ParcelThe identifier of the record parcel. -
ParcelKey(optional):
integer(int64)
The key of the record parcel.
-
Parcelpostalcode(optional):
string
Title:
Property Postal CodeMaximum Length:60The postal code in the parcel or property address. -
Parcelprovince(optional):
string
Title:
Property ProvinceMaximum Length:60The province in the parcel or property address. -
Parcelstate(optional):
string
Title:
Property StateMaximum Length:60The state in the parcel or property address. -
Parceltype(optional):
string
Title:
Parcel TypeMaximum Length:30The type of the current parcel. -
Permitdescription(optional):
string
Title:
Permit DescriptionMaximum Length:1000The description of the permit type. -
Permitstatus(optional):
string
Title:
Permit StatusMaximum Length:100The status of the permit application. -
Personfirstname(optional):
string
Title:
Applicant First NameMaximum Length:150The applicant first name. -
Personlastname(optional):
string
Title:
Applicant Last NameMaximum Length:150The applicant's last name. -
Personmiddlename(optional):
string
Title:
Applicant Middle NameMaximum Length:60The applicant's middle name. -
Persontitle(optional):
string
Title:
Applicant TitleMaximum Length:60The title of the contact. -
Primaryflag(optional):
string
Title:
Primary ContactMaximum Length:1Indicates the primary contact in the contact details. -
Propertydescription(optional):
string
Title:
Property DescriptionMaximum Length:240The property description. -
ReceivedDate(optional):
string(date-time)
Title:
Received DateIdentifies the date when the permit application was received by agency. -
RecordStatus(optional):
string
Maximum Length:
15The status of the record. -
RecordType(optional):
string
Title:
Permit TypeMaximum Length:100The permit type. Agencies define the types of permits that they administer, for example, Residential Addition. -
RecordTypeId(optional):
string
Maximum Length:
30The identifier for a record type. -
Secondaryowner(optional):
string
Title:
Property Secondary OwnerMaximum Length:150The secondary owner of the parcel or property. -
Subclassification(optional):
string
Title:
SubclassificationMaximum Length:80The subclassification code of the permit application type. -
SubmitDate(optional):
string(date-time)
Title:
Submission DateThe date permit application was submitted. -
SystemStatus(optional):
string
Title:
Permit System StatusMaximum Length:15Identifies the system status of the permit application. -
URL(optional):
string
Title:
Permit Overview URLThe URL to access the overview page of the permit application.
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.