Update a record contractor license insurance
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}
Request
Path Parameters
-
LnpLicenseInsKey(required): integer(int64)
This field Indicates the unique identifier of the license for the transaction.
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CancelDate: string
(date)
Title:
Cancellation Date
This field indicates 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 for workers' compensation insurance. -
Exemptdesc: string
Title:
Exemption Reason
Maximum Length:500
This field indicates description of workers' compensation exemption. -
Exemptlongdesc: string
(byte)
This field indicates the long description of workers' compensation exemption.
-
ExpireDate: string
(date)
Title:
Expire Date
This field indicates the expiry date of the policy or bond on the license. -
InsuranceFactRec: string
Maximum Length:
30
This field indicates the type of insurance associated with state license. -
InsuranceType: string
Title:
Insurance Type
Maximum Length:360
This field indicates the type of insurance on license. -
InsurerAmt: number
Title:
Amount
This field indicates the coverage amount on the bond or policy on the license. -
InsurerCode: string
Title:
Code
Maximum Length:30
This field indicates the code associated with insurer on license. -
InsurerLink: string
Maximum Length:
500
The additional URL link to drill into insurer details. -
InsurerName: string
Title:
Company Name
Maximum Length:360
This field indicates the name of insurer on contractor license. -
InsurerPolicyNo: string
Title:
Policy Number
Maximum Length:30
This field indicates the policy number issued by the insurer on license. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
This field Identifies the 3rd party integration. -
IntentToSuspendDate: string
(date)
This field indicates the intent to suspend policy notice date.
-
IntLastUpdDt: string
(date)
Title:
Last Updated Date
This field indicates the date last updated by the 3rd party???s system. -
IssueDate: string
(date)
Title:
Issue Date
This field indicates 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 or the agency. -
LicensePercentage: integer
(int32)
This field indicates the percentage of voting stock in the company.
-
LicenseSetupCode: string
Maximum Length:
30
Default Value:The 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
This field indicates the name of the qualifying individual on bond. -
LicQualifierNameType: string
Maximum Length:
20
This field indicates the type of qualifier bond on bond. -
LnpLicenseKey: integer
(int64)
Title:
License Number
This field indicates the unique identifier of the license transaction. -
RenewalDate: string
(date)
This field indicates the renewal date of the policy or bond on the license.
-
SuspendDate: string
(date)
This field indicates 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:
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.
Root Schema : publicSectorPzRecords-RecordContractorLicense-RecordContractorLicInsurance-item-response
Type:
Show Source
object
-
CancelDate: string
(date)
Title:
Cancellation Date
This field indicates 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 for workers' compensation insurance. -
Exemptdesc: string
Title:
Exemption Reason
Maximum Length:500
This field indicates description of workers' compensation exemption. -
Exemptlongdesc: string
(byte)
This field indicates the long description of workers' compensation exemption.
-
ExpireDate: string
(date)
Title:
Expire Date
This field indicates the expiry date of the policy or bond on the license. -
InsuranceFactRec: string
Maximum Length:
30
This field indicates the type of insurance associated with state license. -
InsuranceType: string
Title:
Insurance Type
Maximum Length:360
This field indicates the type of insurance on license. -
InsurerAmt: number
Title:
Amount
This field indicates the coverage amount on the bond or policy on the license. -
InsurerCode: string
Title:
Code
Maximum Length:30
This field indicates the code associated with insurer on license. -
InsurerLink: string
Maximum Length:
500
The additional URL link to drill into insurer details. -
InsurerName: string
Title:
Company Name
Maximum Length:360
This field indicates the name of insurer on contractor license. -
InsurerPolicyNo: string
Title:
Policy Number
Maximum Length:30
This field indicates the policy number issued by the insurer on license. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
This field Identifies the 3rd party integration. -
IntentToSuspendDate: string
(date)
This field indicates the intent to suspend policy notice date.
-
IntLastUpdDt: string
(date)
Title:
Last Updated Date
This field indicates the date last updated by the 3rd party???s system. -
IssueDate: string
(date)
Title:
Issue Date
This field indicates 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 or the agency. -
LicensePercentage: integer
(int32)
This field indicates the percentage of voting stock in the company.
-
LicenseSetupCode: string
Maximum Length:
30
Default Value:The 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
This field indicates the name of the qualifying individual on bond. -
LicQualifierNameType: string
Maximum Length:
20
This field indicates the type of qualifier bond on bond. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpLicenseInsKey: integer
(int64)
This field Indicates 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
This field indicates 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
This field indicates 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)
This field indicates 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.