Get a contractor validation option
get
/fscmRestApi/resources/11.13.18.05/publicSectorContractorOptions/{publicSectorContractorOptionsUniqID}
Request
Path Parameters
-
publicSectorContractorOptionsUniqID: integer
This is the hash key of the attributes which make up the composite key--- LicenseSetupCode and AgencyId ---for the Contractor Options resource and used to uniquely identify an instance of Contractor Options. The client should not generate the hash key value. Instead, the client should query on the Contractor Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Contractor Options.
For example: publicSectorContractorOptions?q=LicenseSetupCode=<value1>;AgencyId=<value2>
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 : publicSectorContractorOptions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Identifier for the agency that is maintaining contractor license validation.
-
ContractorOptionClassifications(optional):
array Contractor Option Classifications
Title:
Contractor Option Classifications
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses. -
ContractorOptionFacts(optional):
array Contractor Option Facts
Title:
Contractor Option Facts
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses. -
ContractorOptionIntegrations(optional):
array Contractor Option Integrations
Title:
Contractor Option Integrations
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses. -
ContractorOptionLicenseTypes(optional):
array Contractor Option License Types
Title:
Contractor Option License Types
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses. -
ContractorOptionStatusMappings(optional):
array Contractor Option Status Mappings
Title:
Contractor Option Status Mappings
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses. -
Description(optional):
string
Maximum Length:
100
Descriptive statement about the set of configuration options. -
IntegrationEnabled(optional):
string
Maximum Length:
1
Indicates whether a set of contractor license configuration options includes integration with external source. -
LicenseSetupCode(optional):
string
Maximum Length:
30
Code that identifies a set of configuration options for validating contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links(optional):
array Items
Title:
Items
Link Relations -
SelectFacts(optional):
string
Maximum Length:
1
Indicates whether fact sections should be included when contractor license information is displayed. -
SetupEnabled(optional):
string
Maximum Length:
1
Indicates whether a set of contractor license configuration options is enabled or disabled. Only one set of configuration options can be enabled at a time. -
UseClassifications(optional):
string
Maximum Length:
1
Indicates whether classifications should be included when contractor license information is displayed. -
UseLicenseType(optional):
string
Maximum Length:
1
Indicates whether license types should be included when contractor license information is displayed. -
UseStatusMapping(optional):
string
Maximum Length:
1
Indicates whether contractor license external status to internal status mapping is needed.
Nested Schema : Contractor Option Classifications
Type:
array
Title:
Contractor Option Classifications
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
Show Source
Nested Schema : Contractor Option Facts
Type:
array
Title:
Contractor Option Facts
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
Show Source
Nested Schema : Contractor Option Integrations
Type:
array
Title:
Contractor Option Integrations
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
Show Source
Nested Schema : Contractor Option License Types
Type:
array
Title:
Contractor Option License Types
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
Show Source
Nested Schema : Contractor Option Status Mappings
Type:
array
Title:
Contractor Option Status Mappings
The contractor option resource is used to view, add, delete and modify contractor license options for validating licenses.
Show Source
Nested Schema : publicSectorContractorOptions-ContractorOptionClassifications-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Identifier for the agency that is maintaining contractor license information.
-
Description(optional):
string
Maximum Length:
100
Contractor license classification description for the classification section in a set of contractor options. -
Enabled(optional):
string
Maximum Length:
1
Indicates whether a specific contractor license classification is available to be shown when a contractor license information is displayed. -
LicClassification(optional):
string
Maximum Length:
30
Contractor license classification code for the classification section in a set of contractor options. -
LicenseSetupCode(optional):
string
Maximum Length:
20
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links(optional):
array Items
Title:
Items
Link Relations
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 : publicSectorContractorOptions-ContractorOptionFacts-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Identifier for the agency that is maintaining contractor license information.
-
Description(optional):
string
The description of a specific contractor license fact within a fact section.
-
FactSection(optional):
string
Maximum Length:
30
The type of fact record for the contractor data. For example, contractor information for a specific state might include sections for license classifications. -
LicenseSetupCode(optional):
string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links(optional):
array Items
Title:
Items
Link Relations -
SectionEnabled(optional):
string
Maximum Length:
1
Indicates whether a specific fact section should be included when contractor license information is displayed.
Nested Schema : publicSectorContractorOptions-ContractorOptionIntegrations-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Identifier for the agency that is maintaining contractor license information.
-
IntegrationEnabled(optional):
string
Maximum Length:
1
Indicates whether a specific named contractor license integration is active. -
IntegrationKey(optional):
string
Maximum Length:
100
The integration source key that some external sites require for contractor license integration. -
IntegrationName(optional):
string
Maximum Length:
1000
Name of an integration that maps contractor license information to the corresponding license information from an external site. -
IntegrationParameter(optional):
string
Maximum Length:
100
Name of the query parameter that needs to be added to the integration end point. -
IntegrationType(optional):
string
Maximum Length:
30
Identifies the type of integration such as online or batch. -
IntegrationVersion(optional):
string
Maximum Length:
50
Version number of the integration that maps contractor license information to the corresponding license information from an external site. -
LicenseSetupCode(optional):
string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : publicSectorContractorOptions-ContractorOptionLicenseTypes-item
Type:
Show Source
object
-
AgencyId(optional):
string
Maximum Length:
8
Identifier for the agency that is maintaining contractor license information. -
Description(optional):
string
Maximum Length:
100
Descriptive statement about the license type. -
Enabled(optional):
string
Maximum Length:
1
Status of the license type that indicates if the license type is active or inactive. -
LicenseSetupCode(optional):
string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
LicType(optional):
string
Maximum Length:
30
Identifies the type of contractor license. -
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : publicSectorContractorOptions-ContractorOptionStatusMappings-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Identifier for the agency that is maintaining contractor license information.
-
DeclineApplication(optional):
string
Maximum Length:
1
Indicates if applications that are associated with the specified contractor license status should be declined. -
Enabled(optional):
string
Maximum Length:
1
Status of the mapping that indicates if the mapping is active or inactive. -
InternalStatus(optional):
string
Maximum Length:
30
The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body. -
LicenseSetupCode(optional):
string
Maximum Length:
30
Code that identifies a set of configuration options for contractor licenses. For example, a code might represent configuration options that include integration with the state licensing board in California. -
links(optional):
array Items
Title:
Items
Link Relations -
SourceStatus(optional):
string
Maximum Length:
100
Contractor license status that is assigned by a third party licensing body.