Get all contacts
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList
Request
Path Parameters
-
LnpRecordKey: integer
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.
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 a contact with the specified key word. Finder Variables:
- value; string; The keyword used to find a match by address, contact type, email, organization name, person name, phone number, or the primary contact.
- PrimaryKey: Finds a contact using the primary key criteria. Finder Variables:
- ContactKey; integer; The unique identifier of the contact.
- simpleSearchFinder: Finds a contact with the specified key word. 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 : publicSectorRecords-ContactList
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 : publicSectorRecords-ContactList-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Address Line 1
Maximum Length:240
A component of the geographic location for an application that indicates the first line of an address. -
Address2(optional):
string
Title:
Address Line 2
Maximum Length:240
A component of the geographic location for an application that indicates the second line of an address. -
Address3(optional):
string
Title:
Address Line 3
Maximum Length:240
A component of the geographic location for an application that indicates the third line of an address. -
Address4(optional):
string
Title:
Address Line 4
Maximum Length:240
A component of a geographic location for an application that indicates the fourth line of an address. -
AgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier for a public sector agency. -
City(optional):
string
Title:
City
Maximum Length:60
The name of a large, densely populated municipality for a record parcel on the Parcel Address Detail modal page. -
ContactBizPartyId(optional):
integer(int64)
Title:
Contact Business Party
The contact list business party ID. -
ContactBizProfileId(optional):
integer(int64)
The identifier for the contact list business profile.
-
ContactId(optional):
integer(int64)
The unique identifier of the contact.
-
ContactKey(optional):
integer(int64)
Title:
Contact Key
The key value for the contact list. -
ContactPartyId(optional):
integer(int64)
Title:
Contact Party
The contact list party ID. -
ContactProfileId(optional):
integer(int64)
The unique identifier of the user profile.
-
ContactType(optional):
string
Title:
Contact Type
Maximum Length:30
The type of contact in the contact details. -
Country(optional):
string
Title:
Country
Maximum Length:3
The territory of the nation or state in which the record parcel is located, in the parcel address details. -
County(optional):
string
Title:
County
Maximum Length:60
The chief administrative division of a country or state for a record contact, in the contact details. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record was created. -
DateOfBirth(optional):
string(date-time)
Title:
Date of Birth
The applicant date of birth. -
EmailAddress1(optional):
string
Title:
Email
Maximum Length:320
Contact email address for a person or business. -
Gender(optional):
string
Title:
Gender
Maximum Length:30
The applicant sex. Values are male or female. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Record ID
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.
-
OrganizationName(optional):
string
Title:
Organization
Maximum Length:360
The name of the applicant organization. -
PersonFirstName(optional):
string
Title:
First Name
Maximum Length:150
The applicant first name. -
PersonLastName(optional):
string
Title:
Last Name
Maximum Length:150
The applicant last name. -
PersonMiddleName(optional):
string
Title:
Middle Name
Maximum Length:60
The applicant middle name. -
PersonName(optional):
string
Title:
Display Name
Maximum Length:450
The applicant name. -
PersonNameSuffix(optional):
string
Title:
Suffix
Maximum Length:30
The applicant name suffix, such as Junior or Senior. -
PersonPreNameAdjunct(optional):
string
Title:
Salutation
Maximum Length:30
The salutation for the applicant, such as Mr. or Mrs. -
PersonTitle(optional):
string
Title:
Title
Maximum Length:60
The applicant title. -
PhoneAreaCode(optional):
string
Title:
Area Code
Maximum Length:10
The area code in the applicant telephone number. -
PhoneCountryCode(optional):
string
Title:
Country Code
Maximum Length:10
The country code in the applicant telephone number. -
PhoneExtension(optional):
string
Title:
Extension
Maximum Length:20
The extension for the applicant telephone number. -
PhoneNumber(optional):
string
Title:
Phone
Maximum Length:40
The applicant telephone number. -
PostalCode(optional):
string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 Code
Maximum Length:10
The extended postal code in the parcel address. -
PrimaryFlag(optional):
boolean
Title:
Primary
Indicates the primary contact in the contact details. The default value is no. -
Province(optional):
string
Title:
Province
Maximum Length:60
The province in the parcel address. -
State(optional):
string
Title:
State
Maximum Length:60
The state 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.