Create a contractor license agent
post
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseAgents
Request
Path Parameters
-
LicenseKey(required): integer(int64)
The automatically generated number that uniquely identifies the contractor license.
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
-
ActiveLastUpdateBy: string
Maximum Length:
64
The user who last updated the active contact status. -
ActiveLastUpdateDate: string
(date-time)
Date when the user last updated the active status of the contact.
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address of the person who is a contact for the contractor license. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address of the person who is a contact for the contractor license. -
Address3: string
Maximum Length:
240
The third line of the address of the person who is a contact for the contractor license. -
Address4: string
Maximum Length:
240
The fourth line of the address of the person who is a contact for the contractor license. -
AssociateDate: string
(date)
The date when the contact person was associated with the contractor license.
-
AuthorizeAgentFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is an authorized user of the license. -
AuthorizeStatus: string
Maximum Length:
30
Default Value:PV
The status of the contact person who is associated with the contractor license. The status indicates whether the person is a verified contact. -
City: string
Maximum Length:
60
The city for the address of the person who is a contact for the contractor license. -
ContactActive: string
Maximum Length:
1
Default Value:Y
The status for the contact person. -
ContactBizPartyId: integer
(int64)
The business party ID associated with the entity that holds the license.
-
ContactBizProfileId: integer
(int64)
The business profile ID associated with the contact person if the contact person is a registered user.
-
ContactId: string
Maximum Length:
18
The contact ID associated with the contact person for the business license. This attribute is not currently used. -
ContactPartyId: integer
(int64)
The party ID associated with the contact person if the contact person is a registered user.
-
ContactProfileId: integer
(int64)
The profile ID associated with the contact person if the contact person is a registered user.
-
ContactType: string
Title:
Association Type
Maximum Length:30
The contact type or role of the person associated with the license. This attribute is not currently used. -
Country: string
Title:
Country
Maximum Length:3
The country for the address of the person who is a contact for the contractor license. -
County: string
Maximum Length:
60
The country for the address of the person who is a contact for the contractor license. -
DisassociateDate: string
(date)
The date when a former contact person was disassociated from the contractor license.
-
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the person who is a contact for the contractor license. -
JobTitle: string
Title:
Title
Maximum Length:60
The job title of the person who is a contact for the contractor license. -
LicenseAgentKey: integer
(int64)
The unique identifier for the person who is an authorized contact for a contractor license.
-
LicenseHolderFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is a license holder. -
LicenseKey: integer
(int64)
The unique identifier for a contractor license.
-
OrganizationName: string
Maximum Length:
360
The name of the organization of the contact person for the contractor license. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of the person who is authorized as a contact for the contractor license. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
Last name of the person who is authorized as a contact for the contractor license. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person who is authorized as a contact for the contractor license. -
PersonName: string
Maximum Length:
450
The 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: string
Title:
Suffix
Maximum Length:30
The name suffix for the person who is authorized as a contact for the contractor license. -
PersonPreNameAdjunct: string
Title:
Salutation
Maximum Length:30
The salutation of the person associated with the contractor license. -
PhoneAreaCode: string
Maximum Length:
10
The phone area code of the person who is a contact for the contractor license. -
PhoneCountryCode: string
Maximum Length:
10
The phone country code of the person who is a contact for the contractor license. -
PhoneExtension: string
Maximum Length:
20
The phone extension of the person who is a contact for the contractor license. -
PhoneNumber: string
Maximum Length:
40
The phone of the person who is a contact for the contractor license. -
PostalCode: string
Title:
ZIP Code
Maximum Length:60
The postal code for the address of the person who is a contact for the contractor license. -
PrimaryFlag: 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: string
Maximum Length:
60
The province for the address of the person who is a contact for the contractor license. -
State: string
Maximum Length:
60
The state for the address of the person who is a contact for the contractor license. -
VerificationDate: string
(date)
The date when the user last updated the authorization status.
-
VerifiedBy: string
Maximum Length:
64
The user who updated the authorization status.
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 : publicSectorContractorLicenses-ContractorLicenseAgents-item-response
Type:
Show Source
object
-
ActiveLastUpdateBy: string
Maximum Length:
64
The user who last updated the active contact status. -
ActiveLastUpdateDate: string
(date-time)
Date when the user last updated the active status of the contact.
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address of the person who is a contact for the contractor license. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address of the person who is a contact for the contractor license. -
Address3: string
Maximum Length:
240
The third line of the address of the person who is a contact for the contractor license. -
Address4: string
Maximum Length:
240
The fourth line of the address of the person who is a contact for the contractor license. -
AssociateDate: string
(date)
The date when the contact person was associated with the contractor license.
-
AuthorizeAgentFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is an authorized user of the license. -
AuthorizeStatus: string
Maximum Length:
30
Default Value:PV
The status of the contact person who is associated with the contractor license. The status indicates whether the person is a verified contact. -
City: string
Maximum Length:
60
The city for the address of the person who is a contact for the contractor license. -
ContactActive: string
Maximum Length:
1
Default Value:Y
The status for the contact person. -
ContactBizPartyId: integer
(int64)
The business party ID associated with the entity that holds the license.
-
ContactBizProfileId: integer
(int64)
The business profile ID associated with the contact person if the contact person is a registered user.
-
ContactId: string
Maximum Length:
18
The contact ID associated with the contact person for the business license. This attribute is not currently used. -
ContactPartyId: integer
(int64)
The party ID associated with the contact person if the contact person is a registered user.
-
ContactProfileId: integer
(int64)
The profile ID associated with the contact person if the contact person is a registered user.
-
ContactType: string
Title:
Association Type
Maximum Length:30
The contact type or role of the person associated with the license. This attribute is not currently used. -
Country: string
Title:
Country
Maximum Length:3
The country for the address of the person who is a contact for the contractor license. -
County: string
Maximum Length:
60
The country for the address of the person who is a contact for the contractor license. -
DisassociateDate: string
(date)
The date when a former contact person was disassociated from the contractor license.
-
EmailAddress: string
Title:
Email
Maximum Length:320
The email address of the person who is a contact for the contractor license. -
JobTitle: string
Title:
Title
Maximum Length:60
The job title of the person who is a contact for the contractor license. -
LicenseAgentKey: integer
(int64)
The unique identifier for the person who is an authorized contact for a contractor license.
-
LicenseHolderFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is a license holder. -
LicenseKey: integer
(int64)
The unique identifier for a contractor license.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Maximum Length:
360
The name of the organization of the contact person for the contractor license. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of the person who is authorized as a contact for the contractor license. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
Last name of the person who is authorized as a contact for the contractor license. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person who is authorized as a contact for the contractor license. -
PersonName: string
Maximum Length:
450
The 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: string
Title:
Suffix
Maximum Length:30
The name suffix for the person who is authorized as a contact for the contractor license. -
PersonPreNameAdjunct: string
Title:
Salutation
Maximum Length:30
The salutation of the person associated with the contractor license. -
PhoneAreaCode: string
Maximum Length:
10
The phone area code of the person who is a contact for the contractor license. -
PhoneCountryCode: string
Maximum Length:
10
The phone country code of the person who is a contact for the contractor license. -
PhoneExtension: string
Maximum Length:
20
The phone extension of the person who is a contact for the contractor license. -
PhoneNumber: string
Maximum Length:
40
The phone of the person who is a contact for the contractor license. -
PostalCode: string
Title:
ZIP Code
Maximum Length:60
The postal code for the address of the person who is a contact for the contractor license. -
PrimaryFlag: 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: string
Maximum Length:
60
The province for the address of the person who is a contact for the contractor license. -
State: string
Maximum Length:
60
The state for the address of the person who is a contact for the contractor license. -
VerificationDate: string
(date)
The date when the user last updated the authorization status.
-
VerifiedBy: string
Maximum Length:
64
The user who updated the authorization status.
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.