Get a contractor license
get
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}
Request
Path Parameters
-
LicenseKey: integer
Automatically generated number that uniquely identifies the license.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
First address line on the contractor license. -
Address2(optional):
string
Maximum Length:
240
Second address line on the contractor license. -
Address3(optional):
string
Maximum Length:
240
Third address line on the contractor license. -
Address4(optional):
string
Maximum Length:
240
Fourth address line on the contractor license. -
AgencyId(optional):
integer(int32)
The agency ID for the transaction.
-
City(optional):
string
Maximum Length:
60
City of the address on the contractor license. -
ComplaintDiscloureInd(optional):
string
Maximum Length:
1
Indicates whether a complaint has been disclosed against license. -
ContractorLicenseAgents(optional):
array License Agents
Title:
License Agents
The licenses resource is used to view, add, delete and modify general information for a contractor license. -
ContractorLicenseFacts(optional):
array License Facts
Title:
License Facts
The licenses resource is used to view, add, delete and modify general information for a contractor license. -
ContractorLicenseInsurances(optional):
array License Insurances
Title:
License Insurances
The licenses resource is used to view, add, delete and modify general information for a contractor license. -
ContractorLicenseNumber(optional):
string
Maximum Length:
30
The number portion of the contractor license. -
Country(optional):
string
Maximum Length:
60
Country on the address of the contractor license. -
County(optional):
string
Maximum Length:
60
County on the address of the contractor license. -
Dba(optional):
string
Maximum Length:
360
Name the contractor is doing business as. -
EmailAddress(optional):
string
Maximum Length:
320
Email address on a contractor license. -
ExpireDate(optional):
string(date-time)
Expiration date of a contractor license.
-
InactiveDate(optional):
string(date-time)
Date when a contractor license became inactive.
-
IntegrationSource(optional):
string
Maximum Length:
30
The third party that integrates with Oracle to verify contractor licenses. -
InternalLicenseStatus(optional):
string
Maximum Length:
30
A license status that is assigned by agency staff. This is an internally-maintained status that is not related to the status maintained by the licensing organization. -
IntLastUpdateBy(optional):
string
Maximum Length:
64
The user who updated the third party integration data. -
IntLastUpdateDt(optional):
string(date-time)
Date that the third party integration data was last updated.
-
IntStatusLastUpdateBy(optional):
string
Maximum Length:
64
The user who updated the internal license status. -
IntStatusLastUpdateDt(optional):
string(date-time)
Date that the internal license status was last updated.
-
IssueDate(optional):
string(date-time)
Date that the contractor license was originally issued or went in effect.
-
LicenseEntity(optional):
string
Maximum Length:
30
The type of entity that that holds the contractor license. For example, the license can be held by a corporation, partnership, or sole proprietor. -
LicenseKey(optional):
integer(int64)
Automatically generated number that uniquely identifies the license.
-
LicenseLmfPre(optional):
string
Maximum Length:
10
Suffix associated with the contractor license number to indicate Home Improvement Salesperson (HIS) registration number. -
LicenseNumber(optional):
string
Maximum Length:
30
The license number issued by the government. -
LicenseSetupCode(optional):
string
Maximum Length:
30
Setup code that identifies which data sections are used for the license. -
LicenseType(optional):
string
Maximum Length:
30
The type of license issued. -
links(optional):
array Items
Title:
Items
Link Relations -
Name(optional):
string
Maximum Length:
360
Name on the contractor license. -
Owner(optional):
string
Maximum Length:
360
Owner name(s) on the contractor license. -
PhoneAreaCode(optional):
string
Maximum Length:
10
Phone area code on the contractor license. -
PhoneCountryCode(optional):
string
Maximum Length:
10
Phone country code on the contractor license. -
PhoneExtension(optional):
string
Maximum Length:
20
Phone extension on the contractor license. -
PhoneNumber(optional):
string
Maximum Length:
40
Phone number on the contractor license. -
PostalPlus4Code(optional):
string
Maximum Length:
60
Postal code on the address of the contractor license. -
Province(optional):
string
Maximum Length:
60
Province on the address of the contractor license. -
ReactivateDate(optional):
string(date-time)
Date that a contractor license was reactivated after a period when it was inactive.
-
ReissueDate(optional):
string(date-time)
Date that a contractor license was reissued, for example if the entity type has changed.
-
SourceLastUpdateDt(optional):
string(date)
Date that the license information was last updated by the third-party licensing body that validated the license information.
-
SourceStatus(optional):
string
Maximum Length:
100
License status as provided by the third-party licensing body that validated the license information. -
State(optional):
string
Maximum Length:
60
State on the address of the contractor license. -
SuspendDate(optional):
string(date-time)
Date when a contractor license was suspended.
-
UsedInApplication(optional):
string
Maximum Length:
1
Indicates if the license is referenced in any applications.
Nested Schema : License Agents
Type:
array
Title:
License Agents
The licenses resource is used to view, add, delete and modify general information for a contractor license.
Show Source
Nested Schema : License Facts
Type:
array
Title:
License Facts
The licenses resource is used to view, add, delete and modify general information for a contractor license.
Show Source
Nested Schema : License Insurances
Type:
array
Title:
License Insurances
The licenses resource is used to view, add, delete and modify general information for a contractor license.
Show Source
Nested 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.
Nested Schema : publicSectorContractorLicenses-ContractorLicenseFacts-item
Type:
Show Source
object
-
CntrctrLicFactRec(optional):
string
Maximum Length:
30
The type of fact record for the contractor data. For example, contractor data for a specific state might include fact sections for Status and Certifications. -
IntegrationSource(optional):
string
Maximum Length:
30
Identifies an external third party that validates a contractor license and its facts. -
IntLastUpdDt(optional):
string(date-time)
Date that contractor license facts were last updated through integration with a third party system.
-
LicenseFactKey(optional):
integer(int64)
The unique identifier for a fact for a contractor license.
-
LicenseKey(optional):
integer(int64)
The unique identifier for a contractor license.
-
LicFactCode(optional):
string
Maximum Length:
30
The code for this fact item. -
LicFactCodeValue(optional):
string
Maximum Length:
500
The value for this fact item. -
LicFactDate(optional):
string(date-time)
The date for a fact item.
-
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : publicSectorContractorLicenses-ContractorLicenseInsurances-item
Type:
Show Source
object
-
CancelDate(optional):
string(date-time)
Cancellation date of a policy or bond on a contractor license.
-
Exempt(optional):
string
Maximum Length:
30
Indicates whether the contractor is exempt for workers compensation insurance. -
Exemptdesc(optional):
string
Maximum Length:
500
Description of workers' compensation exemption. -
Exemptlongdesc(optional):
string
Long description of worker' compensation exemption.
-
ExpireDate(optional):
string(date-time)
Expiration date of a policy or bond on a contractor license.
-
InsuranceFactRec(optional):
string
Maximum Length:
30
The type of insurance record for the contractor data. Examples of insurance types include contractor bonds and workers compensation. -
InsuranceType(optional):
string
Maximum Length:
30
The type of insurance that is associated with the contractor license. -
InsurerAmt(optional):
number
Coverage amount on bond or insurance policy on a contractor license.
-
InsurerCode(optional):
string
Maximum Length:
30
Code associated with an insurer on a contractor license. -
InsurerLink(optional):
string
Maximum Length:
500
URL that provides access to insurer details. -
InsurerName(optional):
string
Maximum Length:
360
Name of an insurer on a contractor license. -
InsurerPolicyNo(optional):
string
Maximum Length:
30
Policy number issued by an insurer on a contractor license. -
IntegrationSource(optional):
string
Maximum Length:
30
Identifies an external third party that validates contractor license facts. -
IntentToSuspendDate(optional):
string(date-time)
Date of a notice of intent to suspend policy on a contractor license.
-
IntLastUpdDt(optional):
string(date-time)
Date that contractor license facts were last updated through integration with a third party system.
-
IssueDate(optional):
string(date-time)
Issue date of a policy or bond on a contractor license.
-
LicenseInsuranceKey(optional):
integer(int64)
The unique identifier for a type of insurance that is associated with a contractor license.
-
LicenseKey(optional):
integer(int64)
The unique identifier for a contractor license.
-
LicensePercentage(optional):
integer(int32)
The bond holder's percentage of voting stock in company.
-
LicQualifierName(optional):
string
Maximum Length:
360
The name of the qualifying bond holder. -
LicQualifierNameType(optional):
string
Maximum Length:
20
The type of qualifying bond holder. -
links(optional):
array Items
Title:
Items
Link Relations -
RenewalDate(optional):
string(date-time)
Renewal date of a policy or bond on a contractor license.
-
SuspendDate(optional):
string(date-time)
Suspension date of a policy or bond on a contractor license.