Create a set of license agents for a contractor license
post
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
LicenseKey: integer
Automatically generated number that uniquely identifies the license.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorContractorLicenses-ContractorLicenseAgents-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
First line of the address of the person who is a contact for the contractor license. -
Address2(optional):
string
Maximum Length:
240
Second line of the address of the person who is a contact for the contractor license. -
Address3(optional):
string
Maximum Length:
240
Third line of the address of the person who is a contact for the contractor license. -
Address4(optional):
string
Maximum Length:
240
Fourth line of the address of the person who is a contact for the contractor license. -
AssociateDate(optional):
string(date-time)
The date that the contact person was associated with the contractor license.
-
AuthorizeStatus(optional):
string
Maximum Length:
30
Status of the contact person who is associated with the contractor license. The status indicates if the person is a verified contact. -
City(optional):
string
Maximum Length:
60
City for the address of the person who is a contact for the contractor license. -
ContactBizPartyId(optional):
integer(int64)
Business party ID associated with the entity that holds the license.
-
ContactBizProfileId(optional):
integer(int64)
Business Profile ID associated with the contact person if the contact person is a registered user.
-
ContactId(optional):
string
Maximum Length:
18
Contact ID associated with the contact person for the business license. This attribute is not currently used. -
ContactPartyId(optional):
integer(int64)
Party ID associated with the contact person if the contact person is a registered user.
-
ContactProfileId(optional):
integer(int64)
Profile ID associated with the contact person if the contact person is a registered user.
-
ContactType(optional):
string
Maximum Length:
30
The contact type or role of the person associated with the license. This attribute is not currently used. -
Country(optional):
string
Maximum Length:
3
Country for the address of the person who is a contact for the contractor license. -
County(optional):
string
Maximum Length:
60
Country for the address of the person who is a contact for the contractor license. -
DisassociateDate(optional):
string(date-time)
The date that a former contact person was disassociated from the contractor license.
-
EmailAddress(optional):
string
Maximum Length:
320
Email address of the person who is a contact for the contractor license. -
JobTitle(optional):
string
Maximum Length:
60
The job title of the person who is a contact for the contractor license. -
LicenseAgentKey(optional):
integer(int64)
The unique identifier for the person who is an authorized contact for a contractor license.
-
LicenseKey(optional):
integer(int64)
The unique identifier for a contractor license.
-
links(optional):
array Items
Title:
Items
Link Relations -
OrganizationName(optional):
string
Maximum Length:
360
Name of the organization of the contact person for the contractor license. -
PersonFirstName(optional):
string
Maximum Length:
150
First name of the person who is authorized as a contact for the contractor license. -
PersonLastName(optional):
string
Maximum Length:
150
Last name of the person who is authorized as a contact for the contractor license. -
PersonMiddleName(optional):
string
Maximum Length:
60
Middle name of the person who is authorized as a contact for the contractor license. -
PersonName(optional):
string
Maximum Length:
450
Full concatenated name of the person who is authorized as a contact for the contractor license. This includes the person's first, middle, and last names and any name suffix. -
PersonNameSuffix(optional):
string
Maximum Length:
30
Name suffix for the person who is authorized as a contact for the contractor license. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
Salutation of the person associated with the contractor license. -
PhoneAreaCode(optional):
string
Maximum Length:
10
Phone area code of the person who is a contact for the contractor license. -
PhoneCountryCode(optional):
string
Maximum Length:
10
Phone country code of the person who is a contact for the contractor license. -
PhoneExtension(optional):
string
Maximum Length:
20
Phone extension of the person who is a contact for the contractor license. -
PhoneNumber(optional):
string
Maximum Length:
40
Phone of the person who is a contact for the contractor license. -
PostalCode(optional):
string
Maximum Length:
60
Postal code for the address of the person who is a contact for the contractor license. -
PrimaryFlag(optional):
string
Maximum Length:
1
Identifies whether the person associated with the license is the preferred contact for the contractor. This attribute is not currently used. -
Province(optional):
string
Maximum Length:
60
Province for the address of the person who is a contact for the contractor license. -
State(optional):
string
Maximum Length:
60
State for the address of the person who is a contact for the contractor license. -
VerificationDate(optional):
string(date)
The date that the user last updated the authorization status.
-
VerifiedBy(optional):
string
Maximum Length:
64
The user who updated the authorization status.
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 : publicSectorContractorLicenses-ContractorLicenseAgents-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
First line of the address of the person who is a contact for the contractor license. -
Address2(optional):
string
Maximum Length:
240
Second line of the address of the person who is a contact for the contractor license. -
Address3(optional):
string
Maximum Length:
240
Third line of the address of the person who is a contact for the contractor license. -
Address4(optional):
string
Maximum Length:
240
Fourth line of the address of the person who is a contact for the contractor license. -
AssociateDate(optional):
string(date-time)
The date that the contact person was associated with the contractor license.
-
AuthorizeStatus(optional):
string
Maximum Length:
30
Status of the contact person who is associated with the contractor license. The status indicates if the person is a verified contact. -
City(optional):
string
Maximum Length:
60
City for the address of the person who is a contact for the contractor license. -
ContactBizPartyId(optional):
integer(int64)
Business party ID associated with the entity that holds the license.
-
ContactBizProfileId(optional):
integer(int64)
Business Profile ID associated with the contact person if the contact person is a registered user.
-
ContactId(optional):
string
Maximum Length:
18
Contact ID associated with the contact person for the business license. This attribute is not currently used. -
ContactPartyId(optional):
integer(int64)
Party ID associated with the contact person if the contact person is a registered user.
-
ContactProfileId(optional):
integer(int64)
Profile ID associated with the contact person if the contact person is a registered user.
-
ContactType(optional):
string
Maximum Length:
30
The contact type or role of the person associated with the license. This attribute is not currently used. -
Country(optional):
string
Maximum Length:
3
Country for the address of the person who is a contact for the contractor license. -
County(optional):
string
Maximum Length:
60
Country for the address of the person who is a contact for the contractor license. -
DisassociateDate(optional):
string(date-time)
The date that a former contact person was disassociated from the contractor license.
-
EmailAddress(optional):
string
Maximum Length:
320
Email address of the person who is a contact for the contractor license. -
JobTitle(optional):
string
Maximum Length:
60
The job title of the person who is a contact for the contractor license. -
LicenseAgentKey(optional):
integer(int64)
The unique identifier for the person who is an authorized contact for a contractor license.
-
LicenseKey(optional):
integer(int64)
The unique identifier for a contractor license.
-
links(optional):
array Items
Title:
Items
Link Relations -
OrganizationName(optional):
string
Maximum Length:
360
Name of the organization of the contact person for the contractor license. -
PersonFirstName(optional):
string
Maximum Length:
150
First name of the person who is authorized as a contact for the contractor license. -
PersonLastName(optional):
string
Maximum Length:
150
Last name of the person who is authorized as a contact for the contractor license. -
PersonMiddleName(optional):
string
Maximum Length:
60
Middle name of the person who is authorized as a contact for the contractor license. -
PersonName(optional):
string
Maximum Length:
450
Full concatenated name of the person who is authorized as a contact for the contractor license. This includes the person's first, middle, and last names and any name suffix. -
PersonNameSuffix(optional):
string
Maximum Length:
30
Name suffix for the person who is authorized as a contact for the contractor license. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
Salutation of the person associated with the contractor license. -
PhoneAreaCode(optional):
string
Maximum Length:
10
Phone area code of the person who is a contact for the contractor license. -
PhoneCountryCode(optional):
string
Maximum Length:
10
Phone country code of the person who is a contact for the contractor license. -
PhoneExtension(optional):
string
Maximum Length:
20
Phone extension of the person who is a contact for the contractor license. -
PhoneNumber(optional):
string
Maximum Length:
40
Phone of the person who is a contact for the contractor license. -
PostalCode(optional):
string
Maximum Length:
60
Postal code for the address of the person who is a contact for the contractor license. -
PrimaryFlag(optional):
string
Maximum Length:
1
Identifies whether the person associated with the license is the preferred contact for the contractor. This attribute is not currently used. -
Province(optional):
string
Maximum Length:
60
Province for the address of the person who is a contact for the contractor license. -
State(optional):
string
Maximum Length:
60
State for the address of the person who is a contact for the contractor license. -
VerificationDate(optional):
string(date)
The date that the user last updated the authorization status.
-
VerifiedBy(optional):
string
Maximum Length:
64
The user who updated the authorization status.
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.