Update an ownership type for a contractor validation option
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRegContractorOptions/{publicSectorRegContractorOptionsUniqID}/child/ContractorOptionOwnershipTypes/{ContractorOptionOwnershipTypesUniqID}
Request
Path Parameters
-
ContractorOptionOwnershipTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LicenseSetupCode, AgencyId and OwnershipType ---for the Contractor Option Ownership Types resource and used to uniquely identify an instance of Contractor Option Ownership Types. The client should not generate the hash key value. Instead, the client should query on the Contractor Option Ownership Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Contractor Option Ownership Types.
For example: ContractorOptionOwnershipTypes?q=LicenseSetupCode=<value1>;AgencyId=<value2>;OwnershipType=<value3> -
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
-
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.
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-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 : 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.