Update an authorized agent
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent/{LnpAuthorizedAgntKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
LnpAuthorizedAgntKey: integer
The system generated number used uniquely to identify the license.
-
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-RecordAuthorizedAgent-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
This field indicates first address line of contact address. -
Address2(optional):
string
Maximum Length:
240
This field indicates second address line of contact address. -
Address3(optional):
string
Title:
Address Line 3
Maximum Length:240
This field indicates third address line of contact address. -
Address4(optional):
string
Title:
Address Line 4
Maximum Length:240
This field indicates fourth address line of contact address. -
AgentAddressId(optional):
integer(int64)
The reference key to the TCA location table.
-
AgentSource(optional):
string
Maximum Length:
30
The source of the agent. -
ApplicantIsAuthAgentFlag(optional):
string
Maximum Length:
1
Indicates applicant is the authorized agent. -
AssociateDate(optional):
string(date)
The date associated with the Contractor License.
-
AuthorizeStatus(optional):
string
Maximum Length:
30
The status of the agent associated with the contractor license. -
BePersonId(optional):
string
Maximum Length:
200
This field indicates the identifier of a responsible person for the business. -
BePersonKey(optional):
integer(int64)
This field indicates the unique identifier of a responsible person for the business.
-
BusinessEntityId(optional):
string
Maximum Length:
50
The meaningful identifier for the business location. -
BusinessEntityKey(optional):
integer(int64)
The unique identifier for the business entity.
-
BusinessLocationId(optional):
string
Maximum Length:
50
The identifier for the business location. -
BusinessLocationKey(optional):
integer(int64)
The unique identifier for the business location.
-
City(optional):
string
Title:
City
Maximum Length:60
The name of city for the contact address. -
ContactBizPartyId(optional):
integer(int64)
Title:
Business Party
This field indicates party ID associated with the applicant. -
ContactBizProfileId(optional):
integer(int64)
Title:
Business Profile
This field indicates business profile ID associated with the applicant. -
ContactDmvLicExp(optional):
string(date)
The responsible person's driver's license expiration date.
-
ContactDmvLicNum(optional):
string
Maximum Length:
30
The responsible person's driver's license number. -
ContactDmvLicSt(optional):
string
Maximum Length:
60
The responsible person's driver's license issued state. -
ContactId(optional):
integer(int64)
Title:
Contact Key
This field indicates contact ID associated with the applicant. -
ContactPartyId(optional):
integer(int64)
Title:
Contact Party
This field indicates party ID associated with the applicant. -
ContactProfileId(optional):
integer(int64)
Title:
Applicant Profile
This field indicates profile ID associated with the applicant. -
ContactType(optional):
string
Title:
Contact Type
Maximum Length:30
This field Identifies the type of contact the person is associated with the license. -
Country(optional):
string
Maximum Length:
60
This field indicates the name of the country for the contact address. -
County(optional):
string
Title:
County
Maximum Length:60
This field indicates the name of the county for the contact address. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
This attribute indicates the date and time of the creation of the row. -
DateOfBirth(optional):
string(date)
The responsible person's date of birth.
-
DisassociateDate(optional):
string(date)
This field indicates the disassociated date from the Contractor License.
-
EmailAddress(optional):
string
Maximum Length:
320
This field indicates the email address of the person associated with the contractor license. -
EmergContactPhone(optional):
string
Maximum Length:
60
The person's emergency contact phone number. -
EmergencyContactFlag(optional):
string
Maximum Length:
1
Indicates if an emergency contact phone exists. -
JobTitle(optional):
string
Maximum Length:
60
This field identifies the person's job title associated with the contact. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The user who last updated the record. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpAuthorizedAgntKey(optional):
integer(int64)
The system generated number used uniquely to identify the license.
-
LnpLicenseKey(optional):
integer(int64)
The agency staff that verified the responsible person.
-
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
This field indicates the meaningful transaction identifier. -
LnpRecordKey(optional):
integer(int64)
Title:
Record ID
This field indicates the unique identifier of the license. -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
The system attribute that captures the incremental version number for an object. -
OrganizationName(optional):
string
Maximum Length:
360
The organization of person associated with the contractor license. -
PartyId(optional):
integer(int64)
This field indicates the party ID associated with the applicant.
-
PersonFirstName(optional):
string
Maximum Length:
150
This field indicates the first name of person associated with the contractor license. -
PersonLastName(optional):
string
Maximum Length:
150
This field indicates the last name of person associated with the contractor license. -
PersonLengthAtAddress(optional):
number
The length of time the person has been at the address.
-
PersonMiddleName(optional):
string
Title:
Middle Name
Maximum Length:60
This field indicates the middle name of person associated with the contractor license. -
PersonName(optional):
string
Title:
Full Name
Maximum Length:450
This field indicates the full concatenated name including first, middle, last, and suffix names. -
PersonNameSuffix(optional):
string
Maximum Length:
30
This field indicates the suffix associated with the person name. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
The salutation for the responsible person. -
PhoneAreaCode(optional):
string
Title:
Work Phone Country Code
Maximum Length:10
This field indicates the area code of the phone number associated with contact. -
PhoneCountryCode(optional):
string
Title:
Work Phone Country Code
Maximum Length:10
This field indicates the phone country code associated with phone number. -
PhoneExtension(optional):
string
Title:
Phone
Maximum Length:40
This field indicates phone extension associated with the phone number. -
PhoneNumber(optional):
string
Title:
Phone Number
Maximum Length:40
The phone number of the authorized agent. -
PhoneType(optional):
string
Maximum Length:
30
The type of phone for the responsible person. -
PostalCode(optional):
string
Maximum Length:
60
This field indicates the postal code for the contact address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 Code
Maximum Length:60
The extended postal code of the agent. -
PrimaryFlag(optional):
string
Title:
Primary
Maximum Length:1
This field identifies the preferred contact for the contractor. -
Province(optional):
string
Title:
Province
Maximum Length:60
This field indicates the name of the province for the contact address. -
RawPhoneNumber(optional):
string
Maximum Length:
60
The responsible person's full phone number. -
SourceAgentKey(optional):
integer(int64)
The system generated number used uniquely to identify the agent.
-
SourceKey(optional):
integer(int64)
This field Indicates the unique identifier of the source transaction.
-
State(optional):
string
Title:
State
Maximum Length:60
This field indicates the name of state for the contact address. -
Status(optional):
string
Maximum Length:
30
The status of the responsible person for the business. -
SubjectId(optional):
string
Maximum Length:
30
The attribute used to identify where the data should be displayed. -
VerificationDate(optional):
string(date)
The date the responsible person was verified.
-
VerificationStatus(optional):
string
Maximum Length:
30
The verification status for the responsible person. -
VerifiedBy(optional):
string
Maximum Length:
200
The agency staff that verified the responsible person.
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-RecordAuthorizedAgent-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
This field indicates first address line of contact address. -
Address2(optional):
string
Maximum Length:
240
This field indicates second address line of contact address. -
Address3(optional):
string
Title:
Address Line 3
Maximum Length:240
This field indicates third address line of contact address. -
Address4(optional):
string
Title:
Address Line 4
Maximum Length:240
This field indicates fourth address line of contact address. -
AgentAddressId(optional):
integer(int64)
The reference key to the TCA location table.
-
AgentSource(optional):
string
Maximum Length:
30
The source of the agent. -
ApplicantIsAuthAgentFlag(optional):
string
Maximum Length:
1
Indicates applicant is the authorized agent. -
AssociateDate(optional):
string(date)
The date associated with the Contractor License.
-
AuthorizeStatus(optional):
string
Maximum Length:
30
The status of the agent associated with the contractor license. -
BePersonId(optional):
string
Maximum Length:
200
This field indicates the identifier of a responsible person for the business. -
BePersonKey(optional):
integer(int64)
This field indicates the unique identifier of a responsible person for the business.
-
BusinessEntityId(optional):
string
Maximum Length:
50
The meaningful identifier for the business location. -
BusinessEntityKey(optional):
integer(int64)
The unique identifier for the business entity.
-
BusinessLocationId(optional):
string
Maximum Length:
50
The identifier for the business location. -
BusinessLocationKey(optional):
integer(int64)
The unique identifier for the business location.
-
City(optional):
string
Title:
City
Maximum Length:60
The name of city for the contact address. -
ContactBizPartyId(optional):
integer(int64)
Title:
Business Party
This field indicates party ID associated with the applicant. -
ContactBizProfileId(optional):
integer(int64)
Title:
Business Profile
This field indicates business profile ID associated with the applicant. -
ContactDmvLicExp(optional):
string(date)
The responsible person's driver's license expiration date.
-
ContactDmvLicNum(optional):
string
Maximum Length:
30
The responsible person's driver's license number. -
ContactDmvLicSt(optional):
string
Maximum Length:
60
The responsible person's driver's license issued state. -
ContactId(optional):
integer(int64)
Title:
Contact Key
This field indicates contact ID associated with the applicant. -
ContactPartyId(optional):
integer(int64)
Title:
Contact Party
This field indicates party ID associated with the applicant. -
ContactProfileId(optional):
integer(int64)
Title:
Applicant Profile
This field indicates profile ID associated with the applicant. -
ContactType(optional):
string
Title:
Contact Type
Maximum Length:30
This field Identifies the type of contact the person is associated with the license. -
Country(optional):
string
Maximum Length:
60
This field indicates the name of the country for the contact address. -
County(optional):
string
Title:
County
Maximum Length:60
This field indicates the name of the county for the contact address. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
This attribute indicates the date and time of the creation of the row. -
DateOfBirth(optional):
string(date)
The responsible person's date of birth.
-
DisassociateDate(optional):
string(date)
This field indicates the disassociated date from the Contractor License.
-
EmailAddress(optional):
string
Maximum Length:
320
This field indicates the email address of the person associated with the contractor license. -
EmergContactPhone(optional):
string
Maximum Length:
60
The person's emergency contact phone number. -
EmergencyContactFlag(optional):
string
Maximum Length:
1
Indicates if an emergency contact phone exists. -
JobTitle(optional):
string
Maximum Length:
60
This field identifies the person's job title associated with the contact. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The user who last updated the record. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpAuthorizedAgntKey(optional):
integer(int64)
The system generated number used uniquely to identify the license.
-
LnpLicenseKey(optional):
integer(int64)
The agency staff that verified the responsible person.
-
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
This field indicates the meaningful transaction identifier. -
LnpRecordKey(optional):
integer(int64)
Title:
Record ID
This field indicates the unique identifier of the license. -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
The system attribute that captures the incremental version number for an object. -
OrganizationName(optional):
string
Maximum Length:
360
The organization of person associated with the contractor license. -
PartyId(optional):
integer(int64)
This field indicates the party ID associated with the applicant.
-
PersonFirstName(optional):
string
Maximum Length:
150
This field indicates the first name of person associated with the contractor license. -
PersonLastName(optional):
string
Maximum Length:
150
This field indicates the last name of person associated with the contractor license. -
PersonLengthAtAddress(optional):
number
The length of time the person has been at the address.
-
PersonMiddleName(optional):
string
Title:
Middle Name
Maximum Length:60
This field indicates the middle name of person associated with the contractor license. -
PersonName(optional):
string
Title:
Full Name
Maximum Length:450
This field indicates the full concatenated name including first, middle, last, and suffix names. -
PersonNameSuffix(optional):
string
Maximum Length:
30
This field indicates the suffix associated with the person name. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
The salutation for the responsible person. -
PhoneAreaCode(optional):
string
Title:
Work Phone Country Code
Maximum Length:10
This field indicates the area code of the phone number associated with contact. -
PhoneCountryCode(optional):
string
Title:
Work Phone Country Code
Maximum Length:10
This field indicates the phone country code associated with phone number. -
PhoneExtension(optional):
string
Title:
Phone
Maximum Length:40
This field indicates phone extension associated with the phone number. -
PhoneNumber(optional):
string
Title:
Phone Number
Maximum Length:40
The phone number of the authorized agent. -
PhoneType(optional):
string
Maximum Length:
30
The type of phone for the responsible person. -
PostalCode(optional):
string
Maximum Length:
60
This field indicates the postal code for the contact address. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 Code
Maximum Length:60
The extended postal code of the agent. -
PrimaryFlag(optional):
string
Title:
Primary
Maximum Length:1
This field identifies the preferred contact for the contractor. -
Province(optional):
string
Title:
Province
Maximum Length:60
This field indicates the name of the province for the contact address. -
RawPhoneNumber(optional):
string
Maximum Length:
60
The responsible person's full phone number. -
SourceAgentKey(optional):
integer(int64)
The system generated number used uniquely to identify the agent.
-
SourceKey(optional):
integer(int64)
This field Indicates the unique identifier of the source transaction.
-
State(optional):
string
Title:
State
Maximum Length:60
This field indicates the name of state for the contact address. -
Status(optional):
string
Maximum Length:
30
The status of the responsible person for the business. -
SubjectId(optional):
string
Maximum Length:
30
The attribute used to identify where the data should be displayed. -
VerificationDate(optional):
string(date)
The date the responsible person was verified.
-
VerificationStatus(optional):
string
Maximum Length:
30
The verification status for the responsible person. -
VerifiedBy(optional):
string
Maximum Length:
200
The agency staff that verified the responsible person.
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.