Create a set of contractor license insurance
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance
Request
Path Parameters
-
LnpLicenseKey(required): integer(int64)
The system generated number used uniquely to identify the license on the transaction.
-
LnpRecordKey(required): integer(int64)
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
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
The cancellation date of the policy or bond on the license. -
Exempt: string
Title:
Exempt
Maximum Length:30
Default Value:N
Indicates whether the contractor is exempt from workers' compensation insurance. -
Exemptdesc: string
Title:
Exemption Reason
Maximum Length:500
The description of workers' compensation exemption. -
Exemptlongdesc: string
(byte)
The long description of workers' compensation exemption.
-
ExpireDate: string
(date)
Title:
Expire Date
The expiry date of the policy or bond on the license. -
InsuranceFactRec: string
Maximum Length:
30
The type of insurance associated with the state license. -
InsuranceType: string
Title:
Insurance Type
Maximum Length:360
The type of insurance on the license. -
InsurerAmt: number
Title:
Amount
The coverage amount on the bond or policy on the license. -
InsurerCode: string
Title:
Code
Maximum Length:30
The code associated with an insurer on the license. -
InsurerLink: string
Maximum Length:
500
The additional URL link to drill into insurer details. -
InsurerName: string
Title:
Company Name
Maximum Length:360
The name of insurer on the contractor license. -
InsurerPolicyNo: string
Title:
Policy Number
Maximum Length:30
The policy number issued by the insurer on the license. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
Identifies the third party integration. -
IntentToSuspendDate: string
(date)
The intent to suspend policy notice date.
-
IntLastUpdDt: string
(date)
Title:
Last Updated Date
The date when the third party system was last updated. -
IssueDate: string
(date)
Title:
Issue Date
The issue date of the policy or bond on the license. -
LicenseInsuranceKey: integer
(int64)
The system generated number used uniquely to identify the license.
-
LicenseNumber: string
Maximum Length:
50
The license number issued by the government. -
LicensePercentage: integer
(int32)
The percentage of voting stock in the company.
-
LicenseSetupCode: string
Maximum Length:
30
Default Value:Setup code that identifies segments usage on the license. -
LicenseType: string
Maximum Length:
30
The type of the license issued. -
LicQualifierName: string
Title:
Qualifier Name
Maximum Length:360
The name of the qualifying individual on the bond. -
LicQualifierNameType: string
Maximum Length:
20
The type of the qualifier bond. -
LnpLicenseInsKey: integer
(int64)
The unique identifier of the license for the transaction.
-
LnpLicenseInsPuid: string
Maximum Length:
480
The public unique identifier for license insurance, which is an alternate key used by the CRM Import process. -
LnpLicenseKey: integer
(int64)
Title:
License Number
The unique identifier of the license transaction. -
LnpLicensePuid: string
Maximum Length:
480
The parent unique identifier, which is an alternate key used by the CRM Import process. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier for the related transaction. -
RenewalDate: string
(date)
This field indicates the renewal date of the policy or bond on the license.
-
SuspendDate: string
(date)
The suspension date of the policy or bond on the 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 : publicSectorRecords-RecordContractorLicense-RecordContractorLicInsurance-item-response
Type:
Show Source
object
-
CancelDate: string
(date)
Title:
Cancellation Date
The cancellation date of the policy or bond on the license. -
Exempt: string
Title:
Exempt
Maximum Length:30
Default Value:N
Indicates whether the contractor is exempt from workers' compensation insurance. -
Exemptdesc: string
Title:
Exemption Reason
Maximum Length:500
The description of workers' compensation exemption. -
Exemptlongdesc: string
(byte)
The long description of workers' compensation exemption.
-
ExpireDate: string
(date)
Title:
Expire Date
The expiry date of the policy or bond on the license. -
InsuranceFactRec: string
Maximum Length:
30
The type of insurance associated with the state license. -
InsuranceType: string
Title:
Insurance Type
Maximum Length:360
The type of insurance on the license. -
InsurerAmt: number
Title:
Amount
The coverage amount on the bond or policy on the license. -
InsurerCode: string
Title:
Code
Maximum Length:30
The code associated with an insurer on the license. -
InsurerLink: string
Maximum Length:
500
The additional URL link to drill into insurer details. -
InsurerName: string
Title:
Company Name
Maximum Length:360
The name of insurer on the contractor license. -
InsurerPolicyNo: string
Title:
Policy Number
Maximum Length:30
The policy number issued by the insurer on the license. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
Identifies the third party integration. -
IntentToSuspendDate: string
(date)
The intent to suspend policy notice date.
-
IntLastUpdDt: string
(date)
Title:
Last Updated Date
The date when the third party system was last updated. -
IssueDate: string
(date)
Title:
Issue Date
The issue date of the policy or bond on the license. -
LicenseInsuranceKey: integer
(int64)
The system generated number used uniquely to identify the license.
-
LicenseNumber: string
Maximum Length:
50
The license number issued by the government. -
LicensePercentage: integer
(int32)
The percentage of voting stock in the company.
-
LicenseSetupCode: string
Maximum Length:
30
Default Value:Setup code that identifies segments usage on the license. -
LicenseType: string
Maximum Length:
30
The type of the license issued. -
LicQualifierName: string
Title:
Qualifier Name
Maximum Length:360
The name of the qualifying individual on the bond. -
LicQualifierNameType: string
Maximum Length:
20
The type of the qualifier bond. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpLicenseInsKey: integer
(int64)
The unique identifier of the license for the transaction.
-
LnpLicenseInsPuid: string
Maximum Length:
480
The public unique identifier for license insurance, which is an alternate key used by the CRM Import process. -
LnpLicenseKey: integer
(int64)
Title:
License Number
The unique identifier of the license transaction. -
LnpLicensePuid: string
Maximum Length:
480
The parent unique identifier, which is an alternate key used by the CRM Import process. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier for the related transaction. -
RenewalDate: string
(date)
This field indicates the renewal date of the policy or bond on the license.
-
SuspendDate: string
(date)
The suspension date of the policy or bond on the 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.