Update a contact
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/ContactList/{ContactKey}
Request
Path Parameters
-
ContactKey(required): integer(int64)
The key value for the contact list.
-
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.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveLastUpdateBy: string
Maximum Length:
64
Indicates if the person is an active contact for the application. -
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 if the contact person is the applicant for the application. The default value is no. -
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 is granted access to the application. -
ContactActive: string
Maximum Length:
1
Default Value:Y
Indicates the user who last updated the contact???s active status. -
ContactBizPartyId: integer
(int64)
Title:
Contact Business Party
The contact list business party ID. -
ContactBizProfileId: integer
(int64)
The identifier for the contact list business profile.
-
ContactId: integer
(int64)
The unique identifier of the contact.
-
ContactPartyId: integer
(int64)
Title:
Contact Party
The contact list party ID. -
ContactProfileId: integer
(int64)
The unique identifier of the user profile.
-
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 job title of the person associated with the contact. -
LicenseHolderFlag: string
Maximum Length:
1
The person who holds the 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. -
LnpBusinessOwnersKey: integer
(int64)
The unique identifier for the business owner.
-
LnpBusinessOwnersPuid: string
Maximum Length:
480
The unique identifier for the business owner in the legacy system. -
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 a 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 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 the 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.
Response
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 : publicSectorPzRecords-ContactList-item-response
Type:
Show Source
object
-
ActiveLastUpdateBy: string
Maximum Length:
64
Indicates if the person is an active contact for the application. -
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 if the contact person is the applicant for the application. The default value is no. -
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 is granted access to the application. -
ContactActive: string
Maximum Length:
1
Default Value:Y
Indicates the user who last updated the contact???s active status. -
ContactBizPartyId: integer
(int64)
Title:
Contact Business Party
The contact list business party ID. -
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 ID. -
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 job title of the person associated with the contact. -
LicenseHolderFlag: string
Maximum Length:
1
The person who holds the 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 the 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 a 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 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 the 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.