Update a contractor validation option is not allowed
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}
Request
Path Parameters
-
publicSectorRegContractorOptionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LicenseSetupCode and AgencyId ---for the Contractor Options for Registered Users resource and used to uniquely identify an instance of Contractor Options for Registered Users. The client should not generate the hash key value. Instead, the client should query on the Contractor Options for Registered Users collection resource with a filter on the primary key values in order to navigate to a specific instance of Contractor Options for Registered Users.
For example: publicSectorRegContractorOptions?q=LicenseSetupCode=<value1>;AgencyId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ContractorOptionClassifications: array
Contractor Option Classifications
Title:
Contractor Option Classifications
The contractor option classifications resource is used to view, add, delete and modify contractor license classifications. -
ContractorOptionFacts: array
Contractor Option Facts
Title:
Contractor Option Facts
The contractor option facts resource is used to view, add, delete and modify contractor license options that control which license information sections are enabled. -
ContractorOptionInsuranceTypes: array
Contractor Option Insurance Types
Title:
Contractor Option Insurance Types
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types. -
ContractorOptionLicenseTypes: array
Contractor Option License Types
Title:
Contractor Option License Types
The contractor option license types resource is used to view, add, delete, and modify contractor license types. -
ContractorOptionOwnershipTypes: array
Contractor Option Ownership Types
Title:
Contractor Option Ownership Types
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types. -
ContractorOptionStatusMappings: array
Contractor Option Status Mappings
Title:
Contractor Option Status Mappings
The contractor option status mappings resource is used to view, add, delete, and modify contractor validation status mappings. -
Description: string
Title:
Description
Maximum Length:100
Descriptive statement about the set of configuration options. -
DocGroupId: string
Maximum Length:
30
Indicates the document group for contractor license attachments. -
IntegrationEnabled: string
Title:
Integrated with External Source
Maximum Length:1
Indicates whether a set of contractor license configuration options includes integration with external source. -
LimitLicenseUsage: string
Maximum Length:
1
A user can select licenses in an application where the user is an active contact for the license in the agency records. -
SelectFacts: string
Title:
Choose Sections to Display
Maximum Length:1
Default Value:N
Indicates whether detail sections should be included when contractor license information is displayed. -
SetupEnabled: string
Title:
Setup Enabled
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: string
Title:
Use License Classifications
Maximum Length:1
Default Value:N
Indicates whether classifications should be included when contractor license information is displayed. -
UseContractorList: string
Title:
Limit to Contractor List
Maximum Length:1
Default Value:N
Indicates that in application, user can only select a license for a contractor included in agency's list. The default value is N. -
UseLicenseType: string
Title:
Select License Type
Maximum Length:1
Default Value:N
Indicates whether license types should be included when contractor license information is displayed. -
UseStatusMapping: string
Title:
Use Status Rules
Maximum Length:1
Default Value:N
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 classifications resource is used to view, add, delete and modify contractor license classifications.
Show Source
Nested Schema : Contractor Option Facts
Type:
array
Title:
Contractor Option Facts
The contractor option facts resource is used to view, add, delete and modify contractor license options that control which license information sections are enabled.
Show Source
Nested Schema : Contractor Option Insurance Types
Type:
array
Title:
Contractor Option Insurance Types
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types.
Show Source
Nested Schema : Contractor Option License Types
Type:
array
Title:
Contractor Option License Types
The contractor option license types resource is used to view, add, delete, and modify contractor license types.
Show Source
Nested Schema : Contractor Option Ownership Types
Type:
array
Title:
Contractor Option Ownership Types
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types.
Show Source
Nested Schema : Contractor Option Status Mappings
Type:
array
Title:
Contractor Option Status Mappings
The contractor option status mappings resource is used to view, add, delete, and modify contractor validation status mappings.
Show Source
Nested Schema : publicSectorRegContractorOptions-ContractorOptionClassifications-item-patch-request
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:100
Contractor license classification description for the classification section in a set of contractor options. -
Enabled: string
Title:
Enabled
Maximum Length:1
Indicates whether a specific contractor license classification is available to be shown when a contractor license information is displayed.
Nested Schema : publicSectorRegContractorOptions-ContractorOptionFacts-item-patch-request
Type:
Show Source
object
-
SectionEnabled: string
Title:
Enabled
Maximum Length:1
Indicates whether a specific detail section should be included when contractor license information is displayed.
Nested Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:100
The description for the type of insurance associated with a contractor license. -
Enabled: string
Title:
Enabled
Maximum Length:1
The status for the insurance type that indicates whether the insurance type is active or inactive.
Nested Schema : publicSectorRegContractorOptions-ContractorOptionLicenseTypes-item-patch-request
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:100
Descriptive statement about the license type. -
Enabled: string
Title:
Enabled
Maximum Length:1
Status of the license type that indicates if the license type is active or inactive.
Nested Schema : publicSectorRegContractorOptions-ContractorOptionOwnershipTypes-item-patch-request
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:100
The description for the ownership type associated with a contractor license. -
Enabled: string
Title:
Enabled
Maximum Length:1
The status for the ownership type that indicates whether the insurance type is active or inactive.
Nested Schema : schema
Type:
Show Source
object
-
DeclineApplication: string
Title:
Decline Application
Maximum Length:1
Indicates if applications that are associated with the specified contractor license status should be declined. -
Enabled: string
Title:
Enabled
Maximum Length:1
Status of the mapping that indicates if the mapping is active or inactive. -
InternalStatus: string
Title:
Status
Maximum Length:30
The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body.
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 : publicSectorRegContractorOptions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
Identifier for the agency that is maintaining contractor license validation. -
ContractorOptionClassifications: array
Contractor Option Classifications
Title:
Contractor Option Classifications
The contractor option classifications resource is used to view, add, delete and modify contractor license classifications. -
ContractorOptionFacts: array
Contractor Option Facts
Title:
Contractor Option Facts
The contractor option facts resource is used to view, add, delete and modify contractor license options that control which license information sections are enabled. -
ContractorOptionInsuranceTypes: array
Contractor Option Insurance Types
Title:
Contractor Option Insurance Types
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types. -
ContractorOptionLicenseTypes: array
Contractor Option License Types
Title:
Contractor Option License Types
The contractor option license types resource is used to view, add, delete, and modify contractor license types. -
ContractorOptionOwnershipTypes: array
Contractor Option Ownership Types
Title:
Contractor Option Ownership Types
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types. -
ContractorOptionStatusMappings: array
Contractor Option Status Mappings
Title:
Contractor Option Status Mappings
The contractor option status mappings resource is used to view, add, delete, and modify contractor validation status mappings. -
Description: string
Title:
Description
Maximum Length:100
Descriptive statement about the set of configuration options. -
DocGroupId: string
Maximum Length:
30
Indicates the document group for contractor license attachments. -
IntegrationEnabled: string
Title:
Integrated with External Source
Maximum Length:1
Indicates whether a set of contractor license configuration options includes integration with external source. -
LicenseSetupCode: string
Title:
Code
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. -
LimitLicenseUsage: string
Maximum Length:
1
A user can select licenses in an application where the user is an active contact for the license in the agency records. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SelectFacts: string
Title:
Choose Sections to Display
Maximum Length:1
Default Value:N
Indicates whether detail sections should be included when contractor license information is displayed. -
SetupEnabled: string
Title:
Setup Enabled
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: string
Title:
Use License Classifications
Maximum Length:1
Default Value:N
Indicates whether classifications should be included when contractor license information is displayed. -
UseContractorList: string
Title:
Limit to Contractor List
Maximum Length:1
Default Value:N
Indicates that in application, user can only select a license for a contractor included in agency's list. The default value is N. -
UseLicenseType: string
Title:
Select License Type
Maximum Length:1
Default Value:N
Indicates whether license types should be included when contractor license information is displayed. -
UseStatusMapping: string
Title:
Use Status Rules
Maximum Length:1
Default Value:N
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 classifications resource is used to view, add, delete and modify contractor license classifications.
Show Source
Nested Schema : Contractor Option Facts
Type:
array
Title:
Contractor Option Facts
The contractor option facts resource is used to view, add, delete and modify contractor license options that control which license information sections are enabled.
Show Source
Nested Schema : Contractor Option Insurance Types
Type:
array
Title:
Contractor Option Insurance Types
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types.
Show Source
Nested Schema : Contractor Option License Types
Type:
array
Title:
Contractor Option License Types
The contractor option license types resource is used to view, add, delete, and modify contractor license types.
Show Source
Nested Schema : Contractor Option Ownership Types
Type:
array
Title:
Contractor Option Ownership Types
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types.
Show Source
Nested Schema : Contractor Option Status Mappings
Type:
array
Title:
Contractor Option Status Mappings
The contractor option status mappings resource is used to view, add, delete, and modify contractor validation status mappings.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRegContractorOptions-ContractorOptionClassifications-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifier for the agency that is maintaining contractor license information.
-
Description: string
Title:
Description
Maximum Length:100
Contractor license classification description for the classification section in a set of contractor options. -
Enabled: string
Title:
Enabled
Maximum Length:1
Indicates whether a specific contractor license classification is available to be shown when a contractor license information is displayed. -
LicClassification: string
Title:
Code
Maximum Length:30
Contractor license classification code for the classification section in a set of contractor options. -
LicenseSetupCode: 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: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : publicSectorRegContractorOptions-ContractorOptionFacts-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
Identifier for the agency that is maintaining contractor license information. -
Description: string
Read Only:
true
The description of a specific contractor license detail within a detail section. -
FactSection: string
Title:
Section
Maximum Length:30
The type of detail record for the contractor data. For example, contractor information for a specific state might include sections for license classifications. -
LicenseSetupCode: 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: array
Links
Title:
Links
The link relations associated with the resource instance. -
SectionEnabled: string
Title:
Enabled
Maximum Length:1
Indicates whether a specific detail section should be included when contractor license information is displayed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRegContractorOptions-ContractorOptionInsuranceTypes-item-response
Type:
Show Source
object
-
AgencyId: string
Maximum Length:
8
The identifier for the agency that is maintaining contractor license information. -
Description: string
Title:
Description
Maximum Length:100
The description for the type of insurance associated with a contractor license. -
Enabled: string
Title:
Enabled
Maximum Length:1
The status for the insurance type that indicates whether the insurance type is active or inactive. -
InsuranceType: string
Title:
Insurance Type
Maximum Length:30
The code for the type of insurance associated with a contractor license. -
LicenseSetupCode: string
Maximum Length:
30
The 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: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRegContractorOptions-ContractorOptionLicenseTypes-item-response
Type:
Show Source
object
-
AgencyId: string
Maximum Length:
8
Identifier for the agency that is maintaining contractor license information. -
Description: string
Title:
Description
Maximum Length:100
Descriptive statement about the license type. -
Enabled: string
Title:
Enabled
Maximum Length:1
Status of the license type that indicates if the license type is active or inactive. -
LicenseSetupCode: 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: string
Title:
License Type
Maximum Length:30
Identifies the type of contractor license. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRegContractorOptions-ContractorOptionOwnershipTypes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The identifier for the agency that is maintaining license validation.
-
Description: string
Title:
Description
Maximum Length:100
The description for the ownership type associated with a contractor license. -
Enabled: string
Title:
Enabled
Maximum Length:1
The status for the ownership type that indicates whether the insurance type is active or inactive. -
LicenseSetupCode: string
Maximum Length:
30
The 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: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnershipType: string
Title:
Ownership Type
Maximum Length:15
The code for the ownership type associated with a contractor license.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRegContractorOptions-ContractorOptionStatusMappings-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifier for the agency that is maintaining contractor license information.
-
DeclineApplication: string
Title:
Decline Application
Maximum Length:1
Indicates if applications that are associated with the specified contractor license status should be declined. -
Enabled: string
Title:
Enabled
Maximum Length:1
Status of the mapping that indicates if the mapping is active or inactive. -
InternalStatus: string
Title:
Status
Maximum Length:30
The agency-assigned status for a contractor license that corresponds to the status assigned by the third-party licensing body. -
LicenseSetupCode: 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: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceStatus: string
Title:
Source Status
Maximum Length:100
Contractor license status that is assigned by a third party licensing body.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ContractorOptionClassifications
-
Parameters:
- publicSectorRegContractorOptionsUniqID:
$request.path.publicSectorRegContractorOptionsUniqID
The contractor option classifications resource is used to view, add, delete and modify contractor license classifications. - publicSectorRegContractorOptionsUniqID:
- ContractorOptionFacts
-
Parameters:
- publicSectorRegContractorOptionsUniqID:
$request.path.publicSectorRegContractorOptionsUniqID
The contractor option facts resource is used to view, add, delete and modify contractor license options that control which license information sections are enabled. - publicSectorRegContractorOptionsUniqID:
- ContractorOptionInsuranceTypes
-
Parameters:
- publicSectorRegContractorOptionsUniqID:
$request.path.publicSectorRegContractorOptionsUniqID
The contractor option insurance types resource is used to view, add, delete, and modify contractor license insurance types. - publicSectorRegContractorOptionsUniqID:
- ContractorOptionLicenseTypes
-
Parameters:
- publicSectorRegContractorOptionsUniqID:
$request.path.publicSectorRegContractorOptionsUniqID
The contractor option license types resource is used to view, add, delete, and modify contractor license types. - publicSectorRegContractorOptionsUniqID:
- ContractorOptionOwnershipTypes
-
Parameters:
- publicSectorRegContractorOptionsUniqID:
$request.path.publicSectorRegContractorOptionsUniqID
The contractor option ownership types resource is used to view, add, delete, and modify contractor license ownership types. - publicSectorRegContractorOptionsUniqID:
- ContractorOptionStatusMappings
-
Parameters:
- publicSectorRegContractorOptionsUniqID:
$request.path.publicSectorRegContractorOptionsUniqID
The contractor option status mappings resource is used to view, add, delete, and modify contractor validation status mappings. - publicSectorRegContractorOptionsUniqID: