Create a contact
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/ContactList
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
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.
The following table describes the body parameters in the request for this task.
Root 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.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root 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.