Get all contacts
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList
Request
Path Parameters
-
LnpRecordKey(required): 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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 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:- 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.
-
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.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveLastUpdateBy; string; Indicates the user who last updated the contact???s active status.
- ActiveLastUpdateDate; string; Indicates the date when the contact???s active status was last updated.
- Address1; string; A component of the geographic location for an application that indicates the first line of an address.
- Address2; string; A component of the geographic location for an application that indicates the second line of an address.
- Address3; string; A component of the geographic location for an application that indicates the third line of an address.
- Address4; string; A component of a geographic location for an application that indicates the fourth line of an address.
- AgencyId; integer; The unique identifier for a public sector agency.
- ApplicantFlag; string; Indicates whether the contact person is an applicant for the application. The default value is N.
- AuthorizeAgentFlag; string; Indicates whether the contact person is an authorized user of the license.
- City; string; The name of a large, densely populated municipality for a record parcel on the Parcel Address Detail modal page.
- ContactAccess; string; Indicates whether the contact will be granted access to an application.
- ContactActive; string; Indicates whether the person is an active contact for the application.
- ContactBizPartyId; integer; The contact list business party identifier.
- ContactBizProfileId; integer; The identifier for the contact list business profile.
- ContactId; integer; The unique identifier of the contact.
- ContactKey; integer; The key value for the contact list.
- ContactPartyId; integer; The contact list party identifier.
- ContactProfileId; integer; The unique identifier of the user profile.
- ContactPuid; string; The public unique identifier for the contact of the data migration transaction.
- ContactType; string; The type of contact in the contact details.
- Country; string; The territory of the nation or state in which the record parcel is located, in the parcel address details.
- County; string; The chief administrative division of a country or state for a record contact, in the contact details.
- DateOfBirth; string; The applicant date of birth.
- EmailAddress1; string; Contact email address for a person or business.
- Gender; string; The applicant sex. Values are male or female.
- JobTitle; string; The business job title of the contact.
- LicenseHolderFlag; string; Identifies whether the contact is a holder of a contractor license.
- LicenseNumber; string; The license number for the contractor license when contact is a contractor.
- LicenseSetupCode; string; The setup code for the contractor license when contact is a contractor.
- LicenseType; string; The license type for the contractor license when contact is a contractor.
- LnpBusinessOwnersKey; integer; The unique identifier for the business owner.
- LnpBusinessOwnersPuid; string; The unique identifier for a business owner in the legacy system.
- LnpRecordId; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
- 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.
- MakeApplicantDate; string; The date when the contact was made the previous applicant.
- OrganizationName; string; The name of the applicant organization.
- OwnerFlag; string; Indicates whether the contact person is a business owner.
- PersonFirstName; string; The applicant first name.
- PersonLastName; string; The applicant last name.
- PersonMiddleName; string; The applicant middle name.
- PersonName; string; The applicant name.
- PersonNameSuffix; string; The applicant name suffix, such as Junior or Senior.
- PersonPreNameAdjunct; string; The salutation for the applicant, such as Mr. or Mrs.
- PersonTitle; string; The applicant title.
- PhoneAreaCode; string; The area code in the applicant telephone number.
- PhoneAreaCodeAlt; string; The area code in the contact's alternate telephone number.
- PhoneCountryCode; string; The country code in the applicant telephone number.
- PhoneCountryCodeAlt; string; The country code in the contact's alternate telephone number.
- PhoneExtension; string; The extension for the applicant telephone number.
- PhoneNumber; string; The applicant telephone number.
- PhoneNumberAlt; string; The alternate phone number for the contact.
- PostalCode; string; The postal code in the parcel address.
- PostalPlus4Code; string; The extended postal code in the parcel address.
- PreviousApplicantFlag; string; Indicates whether the contact is a previous applicant. The default value is N.
- PrimaryFlag; boolean; Indicates the primary contact in the contact details. The default value is no.
- Province; string; The province in the parcel address.
- RecordNumber; string; The parent record number for the data migration transaction.
- State; string; The state in the parcel address.
-
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".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorRecords-ContactList
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecords-ContactList-item-response
Type:
Show Source
object
-
ActiveLastUpdateBy: string
Maximum Length:
64
Indicates the user who last updated the contact???s active status. -
ActiveLastUpdateDate: string
(date)
Indicates the date when the contact???s active status was last updated.
-
Address1: 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: 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: 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: 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: integer
Title:
Agency ID
Default Value:1
The unique identifier for a public sector agency. -
ApplicantFlag: string
Title:
Applicant
Maximum Length:1
Default Value:N
Indicates whether the contact person is an applicant for the application. The default value is N. -
AuthorizeAgentFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is an authorized user of the license. -
City: 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. -
ContactAccess: string
Maximum Length:
30
Indicates whether the contact will be granted access to an application. -
ContactActive: string
Maximum Length:
1
Default Value:Y
Indicates whether the person is an active contact for the application. -
ContactBizPartyId: integer
(int64)
Title:
Contact Business Party
The contact list business party identifier. -
ContactBizProfileId: integer
(int64)
The identifier for the contact list business profile.
-
ContactId: integer
(int64)
The unique identifier of the contact.
-
ContactKey: integer
(int64)
Title:
Contact Key
The key value for the contact list. -
ContactPartyId: integer
(int64)
Title:
Contact Party
The contact list party identifier. -
ContactProfileId: integer
(int64)
The unique identifier of the user profile.
-
ContactPuid: string
Maximum Length:
480
The public unique identifier for the contact of the data migration transaction. -
ContactRole: string
The role assigned to the contact. Indicates whether the contact is an applicant, business owner, or previous owner.
-
ContactType: string
Title:
Contact Type
Maximum Length:30
The type of contact in the contact details. -
Country: 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: string
Title:
County
Maximum Length:60
The chief administrative division of a country or state for a record contact, in the contact details. -
DateOfBirth: string
(date)
Title:
Date of Birth
The applicant date of birth. -
EmailAddress1: string
Title:
Email
Maximum Length:320
Contact email address for a person or business. -
Gender: string
Title:
Gender
Maximum Length:30
The applicant sex. Values are male or female. -
JobTitle: string
Maximum Length:
60
The business job title of the contact. -
LicenseHolderFlag: string
Maximum Length:
1
Identifies whether the contact is a holder of a contractor license. -
LicenseNumber: string
Maximum Length:
30
The license number for the contractor license when contact is a contractor. -
LicenseSetupCode: string
Maximum Length:
30
The setup code for the contractor license when contact is a contractor. -
LicenseType: string
Maximum Length:
30
The license type for the contractor license when contact is a contractor. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpBusinessOwnersKey: integer
(int64)
The unique identifier for the business owner.
-
LnpBusinessOwnersPuid: string
Maximum Length:
480
The unique identifier for a business owner in the legacy system. -
LnpRecordId: 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: integer
(int64)
Title:
Record
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. -
MakeApplicantDate: string
(date)
The date when the contact was made the previous applicant.
-
OrganizationName: string
Title:
Organization
Maximum Length:360
The name of the applicant organization. -
OwnerFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is a business owner. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The applicant first name. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The applicant last name. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The applicant middle name. -
PersonName: string
Title:
Display Name
Maximum Length:450
The applicant name. -
PersonNameSuffix: string
Title:
Suffix
Maximum Length:30
The applicant name suffix, such as Junior or Senior. -
PersonPreNameAdjunct: string
Title:
Salutation
Maximum Length:30
The salutation for the applicant, such as Mr. or Mrs. -
PersonTitle: string
Title:
Title
Maximum Length:60
The applicant title. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:10
The area code in the applicant telephone number. -
PhoneAreaCodeAlt: string
Maximum Length:
10
The area code in the contact's alternate telephone number. -
PhoneCountryCode: string
Title:
Country Code
Maximum Length:10
The country code in the applicant telephone number. -
PhoneCountryCodeAlt: string
Maximum Length:
10
The country code in the contact's alternate telephone number. -
PhoneExtension: string
Title:
Extension
Maximum Length:20
The extension for the applicant telephone number. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The applicant telephone number. -
PhoneNumberAlt: string
Maximum Length:
40
The alternate phone number for the contact. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The extended postal code in the parcel address. -
PreviousApplicantFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact is a previous applicant. The default value is N. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary contact in the contact details. The default value is no. -
PrimaryFlagYN: string
The primary contact in the contact details. It's a read-only attribute.
-
Province: string
Title:
Province
Maximum Length:60
The province in the parcel address. -
RecordNumber: string
Maximum Length:
64
The parent record number for the data migration transaction. -
State: string
Title:
State
Maximum Length:60
The state in the parcel address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.