Create a set of license insurances for a contractor license
post
/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenseInsurances
Request
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
-
CancelDate: string
(date)
Title:
Cancellation Date
Cancellation date of a policy or bond on a contractor license. -
Exempt: string
Title:
Exempt
Maximum Length:30
Default Value:N
Indicates whether the contractor is exempt for workers compensation insurance. -
Exemptdesc: string
Title:
Exemption Reason
Maximum Length:500
Description of workers' compensation exemption. -
Exemptlongdesc: string
(byte)
Long description of worker' compensation exemption.
-
ExpireDate: string
(date)
Title:
Expiration Date
Expiration date of a policy or bond on a contractor license. -
InsuranceFactRec: string
Maximum Length:
30
The type of insurance record for the contractor data. Examples of insurance types include contractor bonds and workers compensation. -
InsuranceType: string
Title:
Coverage Type
Maximum Length:360
The type of insurance that is associated with the contractor license. -
InsurerAmt: number
Title:
Amount
Coverage amount on bond or insurance policy on a contractor license. -
InsurerCode: string
Maximum Length:
30
Code associated with an insurer on a contractor license. -
InsurerLink: string
Maximum Length:
500
URL that provides access to insurer details. -
InsurerName: string
Title:
Company Name
Maximum Length:360
Name of an insurer on a contractor license. -
InsurerPolicyNo: string
Title:
Policy Number
Maximum Length:30
Policy number issued by an insurer on a contractor license. -
IntegrationSource: string
Maximum Length:
30
Identifies an external third party that validates contractor license facts. -
IntentToSuspendDate: string
(date)
Date of a notice of intent to suspend policy on a contractor license.
-
IntLastUpdDt: string
(date)
Date that contractor license facts were last updated through integration with a third party system.
-
IssueDate: string
(date)
Title:
Effective Date
Issue date of a policy or bond on a contractor license. -
LicenseInsuranceKey: integer
(int64)
The unique identifier for a type of insurance that is associated with a contractor license.
-
LicenseKey: integer
(int64)
The unique identifier for a contractor license.
-
LicenseNumber: string
Maximum Length:
50
Default Value:The contractor license number issued by the government. -
LicensePercentage: integer
(int32)
The bond holder's percentage of voting stock in company.
-
LicenseSetupCode: string
Maximum Length:
30
Default Value:The code that identifies which data sections are used for the contractor license. -
LicenseType: string
Maximum Length:
30
Default Value:The type of contractor license issued. -
LicQualifierName: string
Title:
Qualifier Name
Maximum Length:360
The name of the qualifying bond holder. -
LicQualifierNameType: string
Maximum Length:
20
The type of qualifying bond holder. -
RenewalDate: string
(date)
Renewal date of a policy or bond on a contractor license.
-
SuspendDate: string
(date)
Title:
Suspend Date
Suspension date of a policy or bond on a contractor license.
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 : publicSectorContractorLicenseInsurances-item-response
Type:
Show Source
object
-
CancelDate: string
(date)
Title:
Cancellation Date
Cancellation date of a policy or bond on a contractor license. -
Exempt: string
Title:
Exempt
Maximum Length:30
Default Value:N
Indicates whether the contractor is exempt for workers compensation insurance. -
Exemptdesc: string
Title:
Exemption Reason
Maximum Length:500
Description of workers' compensation exemption. -
Exemptlongdesc: string
(byte)
Long description of worker' compensation exemption.
-
ExpireDate: string
(date)
Title:
Expiration Date
Expiration date of a policy or bond on a contractor license. -
InsuranceFactRec: string
Maximum Length:
30
The type of insurance record for the contractor data. Examples of insurance types include contractor bonds and workers compensation. -
InsuranceType: string
Title:
Coverage Type
Maximum Length:360
The type of insurance that is associated with the contractor license. -
InsurerAmt: number
Title:
Amount
Coverage amount on bond or insurance policy on a contractor license. -
InsurerCode: string
Maximum Length:
30
Code associated with an insurer on a contractor license. -
InsurerLink: string
Maximum Length:
500
URL that provides access to insurer details. -
InsurerName: string
Title:
Company Name
Maximum Length:360
Name of an insurer on a contractor license. -
InsurerPolicyNo: string
Title:
Policy Number
Maximum Length:30
Policy number issued by an insurer on a contractor license. -
IntegrationSource: string
Maximum Length:
30
Identifies an external third party that validates contractor license facts. -
IntentToSuspendDate: string
(date)
Date of a notice of intent to suspend policy on a contractor license.
-
IntLastUpdDt: string
(date)
Date that contractor license facts were last updated through integration with a third party system.
-
IssueDate: string
(date)
Title:
Effective Date
Issue date of a policy or bond on a contractor license. -
LicenseInsuranceKey: integer
(int64)
The unique identifier for a type of insurance that is associated with a contractor license.
-
LicenseKey: integer
(int64)
The unique identifier for a contractor license.
-
LicenseNumber: string
Maximum Length:
50
Default Value:The contractor license number issued by the government. -
LicensePercentage: integer
(int32)
The bond holder's percentage of voting stock in company.
-
LicenseSetupCode: string
Maximum Length:
30
Default Value:The code that identifies which data sections are used for the contractor license. -
LicenseType: string
Maximum Length:
30
Default Value:The type of contractor license issued. -
LicQualifierName: string
Title:
Qualifier Name
Maximum Length:360
The name of the qualifying bond holder. -
LicQualifierNameType: string
Maximum Length:
20
The type of qualifying bond holder. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RenewalDate: string
(date)
Renewal date of a policy or bond on a contractor license.
-
SuspendDate: string
(date)
Title:
Suspend Date
Suspension date of a policy or bond on 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.