Create a set of authorized agents
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first address line of contact address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line of contact address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line of contact address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line of contact address. -
AgentAddressId: integer
(int64)
The reference key to the TCA location table.
-
AgentSource: string
Maximum Length:
30
The source of the agent. -
ApplicantIsAuthAgentFlag: string
Title:
Is the applicant an authorized agent?
Maximum Length:1
Indicates whether an applicant is the authorized agent. -
AssociateDate: string
(date)
The date associated with the Contractor License.
-
AuthorizeStatus: string
Title:
Verification Status
Maximum Length:30
The status of the agent associated with the contractor license. -
BePersonId: string
Maximum Length:
200
The identifier of a responsible person for the business. -
BePersonKey: integer
(int64)
The unique identifier of a responsible person for the business.
-
BusinessEntityId: string
Maximum Length:
50
The meaningful identifier for the business location. -
BusinessEntityKey: integer
(int64)
The unique identifier for the business entity.
-
BusinessLocationId: string
Maximum Length:
50
The identifier for the business location. -
BusinessLocationKey: integer
(int64)
The unique identifier for the business location.
-
City: string
Title:
City
Maximum Length:60
The name of city for the contact address. -
ContactBizPartyId: integer
(int64)
Title:
Business Party
The party identifier associated with the applicant. -
ContactBizProfileId: integer
(int64)
Title:
Business Profile
The business profile identifier associated with the applicant. -
ContactDmvLicExp: string
(date)
The responsible person???s driver???s license expiration date.
-
ContactDmvLicNum: string
Maximum Length:
30
The responsible person???s driver???s license number. -
ContactDmvLicSt: string
Maximum Length:
60
The responsible person???s driver???s license issued state. -
ContactId: integer
(int64)
Title:
Contact Key
The contact identifier associated with the applicant. -
ContactPartyId: integer
(int64)
Title:
Contact Party
The party identifier associated with the applicant. -
ContactProfileId: integer
(int64)
Title:
Applicant Profile
The profile identifier associated with the applicant. -
ContactType: string
Title:
Contact Type
Maximum Length:30
The contact type of the person who is associated with the license. -
Country: string
Title:
Country
Maximum Length:60
The name of the country for the contact address. -
County: string
Title:
County
Maximum Length:60
This field indicates the name of the county for the contact address. -
DateOfBirth: string
(date)
The responsible person???s date of birth.
-
DisassociateDate: string
(date)
The disassociated date from the contractor license.
-
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the person associated with the contractor license. -
EmergContactPhone: string
Maximum Length:
60
The person???s emergency contact phone number. -
EmergencyContactFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an emergency contact phone number exists. -
JobTitle: string
Title:
Title
Maximum Length:60
The person???s job title associated with the contact. -
LnpAuthorizedAgntKey: integer
(int64)
The system generated number used uniquely to identify the license.
-
LnpAuthorizedAgntPuid: string
Maximum Length:
480
The public unique identifier for authorized agent, which is an alternate key used by the CRM Import process. -
LnpLicenseKey: integer
(int64)
The agency staff that verified the responsible person.
-
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier of the license. -
OrganizationName: string
Title:
Company Name
Maximum Length:360
The organization of a person associated with the contractor license. -
PartyId: integer
(int64)
The party identifier associated with the applicant.
-
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of a person associated with the contractor license. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The last name of a person associated with the contractor license. -
PersonLengthAtAddress: integer
(int64)
The length of time the person has been at the address.
-
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of a person associated with the contractor license. -
PersonName: string
Title:
Full Name
Maximum Length:450
The full concatenated name including first, middle, last, and suffix names. -
PersonNameSuffix: string
Title:
Suffix
Maximum Length:30
The suffix associated with the person's name. -
PersonPreNameAdjunct: string
Title:
Salutation
Maximum Length:30
The salutation for the responsible person. -
PhoneAreaCode: string
Title:
Work Phone Country Code
Maximum Length:10
The area code of the phone number associated with contact. -
PhoneCountryCode: string
Title:
Work Phone Country Code
Maximum Length:10
The phone country code associated with phone number. -
PhoneExtension: string
Title:
Phone
Maximum Length:40
The phone extension associated with the phone number. -
PhoneNumber: string
Title:
Phone Number
Maximum Length:40
The phone number of the authorized agent. -
PhoneType: string
Maximum Length:
30
The type of phone for the responsible person. -
PostalCode: string
Title:
ZIP Code
Maximum Length:60
The postal code of the contact address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:60
The extended postal code of the agent. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
The preferred contact for the contractor. -
Province: string
Title:
Province
Maximum Length:60
The province name for the contact address. -
RawPhoneNumber: string
Maximum Length:
60
The responsible person???s full phone number. -
RecordNumber: string
Maximum Length:
64
The public unique identifier for the permit record that is used by the CRM Import process. -
SourceAgentKey: integer
(int64)
The system generated number used uniquely to identify the agent.
-
SourceKey: integer
(int64)
The unique identifier of the source transaction.
-
State: string
Title:
State
Maximum Length:60
The state name of the contact address. -
Status: string
Maximum Length:
30
The status of the responsible person for the business. -
SubjectId: string
Maximum Length:
30
The attribute used to identify where the data should be displayed. -
VerificationDate: string
(date)
The date the responsible person was verified.
-
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
The verification status for the responsible person. -
VerifiedBy: string
Maximum Length:
200
The agency staff that verified the responsible person.
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 : publicSectorRecords-RecordAuthorizedAgent-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first address line of contact address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line of contact address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line of contact address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line of contact address. -
AgentAddressId: integer
(int64)
The reference key to the TCA location table.
-
AgentSource: string
Maximum Length:
30
The source of the agent. -
ApplicantIsAuthAgentFlag: string
Title:
Is the applicant an authorized agent?
Maximum Length:1
Indicates whether an applicant is the authorized agent. -
AssociateDate: string
(date)
The date associated with the Contractor License.
-
AuthorizeStatus: string
Title:
Verification Status
Maximum Length:30
The status of the agent associated with the contractor license. -
BePersonId: string
Maximum Length:
200
The identifier of a responsible person for the business. -
BePersonKey: integer
(int64)
The unique identifier of a responsible person for the business.
-
BusinessEntityId: string
Maximum Length:
50
The meaningful identifier for the business location. -
BusinessEntityKey: integer
(int64)
The unique identifier for the business entity.
-
BusinessLocationId: string
Maximum Length:
50
The identifier for the business location. -
BusinessLocationKey: integer
(int64)
The unique identifier for the business location.
-
City: string
Title:
City
Maximum Length:60
The name of city for the contact address. -
ContactBizPartyId: integer
(int64)
Title:
Business Party
The party identifier associated with the applicant. -
ContactBizProfileId: integer
(int64)
Title:
Business Profile
The business profile identifier associated with the applicant. -
ContactDmvLicExp: string
(date)
The responsible person???s driver???s license expiration date.
-
ContactDmvLicNum: string
Maximum Length:
30
The responsible person???s driver???s license number. -
ContactDmvLicSt: string
Maximum Length:
60
The responsible person???s driver???s license issued state. -
ContactId: integer
(int64)
Title:
Contact Key
The contact identifier associated with the applicant. -
ContactPartyId: integer
(int64)
Title:
Contact Party
The party identifier associated with the applicant. -
ContactProfileId: integer
(int64)
Title:
Applicant Profile
The profile identifier associated with the applicant. -
ContactType: string
Title:
Contact Type
Maximum Length:30
The contact type of the person who is associated with the license. -
Country: string
Title:
Country
Maximum Length:60
The name of the country for the contact address. -
County: string
Title:
County
Maximum Length:60
This field indicates the name of the county for the contact address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of the creation of the row. -
DateOfBirth: string
(date)
The responsible person???s date of birth.
-
DisassociateDate: string
(date)
The disassociated date from the contractor license.
-
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the person associated with the contractor license. -
EmergContactPhone: string
Maximum Length:
60
The person???s emergency contact phone number. -
EmergencyContactFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an emergency contact phone number exists. -
JobTitle: string
Title:
Title
Maximum Length:60
The person???s job title associated with the contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpAuthorizedAgntKey: integer
(int64)
The system generated number used uniquely to identify the license.
-
LnpAuthorizedAgntPuid: string
Maximum Length:
480
The public unique identifier for authorized agent, which is an alternate key used by the CRM Import process. -
LnpLicenseKey: integer
(int64)
The agency staff that verified the responsible person.
-
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier of the license. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Read Only:true
The system attribute that captures the incremental version number for an object. -
OrganizationName: string
Title:
Company Name
Maximum Length:360
The organization of a person associated with the contractor license. -
PartyId: integer
(int64)
The party identifier associated with the applicant.
-
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of a person associated with the contractor license. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The last name of a person associated with the contractor license. -
PersonLengthAtAddress: integer
(int64)
The length of time the person has been at the address.
-
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of a person associated with the contractor license. -
PersonName: string
Title:
Full Name
Maximum Length:450
The full concatenated name including first, middle, last, and suffix names. -
PersonNameSuffix: string
Title:
Suffix
Maximum Length:30
The suffix associated with the person's name. -
PersonPreNameAdjunct: string
Title:
Salutation
Maximum Length:30
The salutation for the responsible person. -
PhoneAreaCode: string
Title:
Work Phone Country Code
Maximum Length:10
The area code of the phone number associated with contact. -
PhoneCountryCode: string
Title:
Work Phone Country Code
Maximum Length:10
The phone country code associated with phone number. -
PhoneExtension: string
Title:
Phone
Maximum Length:40
The phone extension associated with the phone number. -
PhoneNumber: string
Title:
Phone Number
Maximum Length:40
The phone number of the authorized agent. -
PhoneType: string
Maximum Length:
30
The type of phone for the responsible person. -
PostalCode: string
Title:
ZIP Code
Maximum Length:60
The postal code of the contact address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:60
The extended postal code of the agent. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
The preferred contact for the contractor. -
Province: string
Title:
Province
Maximum Length:60
The province name for the contact address. -
RawPhoneNumber: string
Maximum Length:
60
The responsible person???s full phone number. -
RecordNumber: string
Maximum Length:
64
The public unique identifier for the permit record that is used by the CRM Import process. -
SourceAgentKey: integer
(int64)
The system generated number used uniquely to identify the agent.
-
SourceKey: integer
(int64)
The unique identifier of the source transaction.
-
State: string
Title:
State
Maximum Length:60
The state name of the contact address. -
Status: string
Maximum Length:
30
The status of the responsible person for the business. -
SubjectId: string
Maximum Length:
30
The attribute used to identify where the data should be displayed. -
VerificationDate: string
(date)
The date the responsible person was verified.
-
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
The verification status for the responsible person. -
VerifiedBy: string
Maximum Length:
200
The agency staff that verified the responsible person.
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.