Get a permit contact
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/ContactLists/{ContactKey}
Request
Path Parameters
-
ContactKey(required): integer(int64)
The unique identifier for the contact.
-
LnpRecordKey(required): 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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:
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.
Root Schema : publicSectorRecordQueries-ContactLists-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
The first address line for the contact person. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line for the contact person. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line for the contact person. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line for the contact person. -
AgencyId: integer
Title:
Agency ID
Default Value:1
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. -
ApplicantFlag: string
Title:
Applicant
Maximum Length:1
Default Value:N
This field indicates if the contact is an applicant. -
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 city for the contact person's address. -
ContactAccess: string
Maximum Length:
30
Indicates whether the contact is granted access to the application. -
ContactActive: string
Maximum Length:
1
Default Value:Y
The contact status of the person. -
ContactBizPartyId: integer
(int64)
Title:
Contact Business Party
The contact list business party ID. -
ContactBizProfileId: integer
(int64)
The unique identifier of the contact's business profile when the contact ID is a business entity.
-
ContactId: integer
(int64)
The unique identifier of the contact.
-
ContactKey: integer
(int64)
Title:
Contact Key
The unique identifier for the contact. -
ContactPartyId: integer
(int64)
Title:
Contact Party
The contact list party ID. -
ContactProfileId: integer
(int64)
The profile ID of the contact.
-
ContactPuid: string
Maximum Length:
480
The parent unique identifier, which is an alternate key used by the CRM Import process. -
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
Identifies the contact type of the primary contact of the permit application. -
Country: string
Title:
Country
Maximum Length:3
The country for the contact person. -
County: string
Title:
County
Maximum Length:60
The county for the contact person's address. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date of birth of the contact person's address. -
EmailAddress1: string
Title:
Email
Maximum Length:320
The email for the contact person's address. -
Gender: string
Title:
Gender
Maximum Length:30
The gender for the contact person's gender. -
JobTitle: string
Maximum Length:
60
The job title of the person associated with the contact. -
LicenseHolderFlag: string
Maximum Length:
1
Indicates the person to whom the contractor license was issued. -
LicenseNumber: string
Maximum Length:
30
The license number for the applicant when the contact is an applicant. -
LicenseSetupCode: string
Maximum Length:
30
The setup code for the applicant when the contact is an applicant. -
LicenseType: string
Maximum Length:
30
The license type for the applicant when the contact is an applicant. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpBusinessOwnersKey: integer
(int64)
Unique identifier for the business owner.
-
LnpBusinessOwnersPuid: string
Maximum Length:
480
The unique identifier for the business owner in the legacy system. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier for a permit type. -
MakeApplicantDate: string
(date)
The date when the contact was made a previous applicant.
-
OrganizationName: string
Title:
Organization
Maximum Length:360
The name of the applicant's 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 contact person's first name. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The contact person's last name. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The contact person's middle name. -
PersonName: string
Title:
Display Name
Maximum Length:450
The contact person's name. -
PersonNameSuffix: string
Title:
Suffix
Maximum Length:30
The contact name suffix, such as Junior or Senior. -
PersonPreNameAdjunct: string
Title:
Salutation
Maximum Length:30
The salutation for the contact such as Mr. or Mrs. -
PersonTitle: string
Title:
Title
Maximum Length:60
The title of the contact person. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:10
The area code in the contact telephone number. -
PhoneAreaCodeAlt: string
Maximum Length:
10
The alternate area code in the contact person's telephone number. -
PhoneCountryCode: string
Title:
Country Code
Maximum Length:10
The country code in the contact telephone number. -
PhoneCountryCodeAlt: string
Maximum Length:
10
The alternate country code in the contact person telephone number. -
PhoneExtension: string
Title:
Extension
Maximum Length:20
The extension for the contact's telephone number. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The contact person's phone number. -
PhoneNumberAlt: string
Maximum Length:
40
The contact person's telephone number. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code for the contact person's address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The extended postal code in the contact list. -
PreviousApplicantFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact is the previous applicant. The default value is N. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary contact in the contact details. -
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 contact person's address. -
RecordNumber: string
Maximum Length:
64
The public unique identifier of the parent record. -
State: string
Title:
State
Maximum Length:60
The state in the contact person's 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.