Jump to

• Request
• Response

Update a record contractor license insurance

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicInsurance/{LnpLicenseInsKey}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• LnpLicenseInsKey: integer
  This field Indicates the unique identifier of the license for the transaction.
• LnpLicenseKey: integer
  The system generated number used uniquely to identify the license on the transaction.
• LnpRecordKey: integer
  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.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorRecords-RecordContractorLicense-RecordContractorLicInsurance-item

Type: object

Show Source

• CancelDate(optional): string(date)
  This field indicates the cancellation date of the policy or bond on the license.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  This indicates the date and time of the creation of the row.
• Exempt(optional): string
  Maximum Length: 30

  Indicates whether the contractor is exempt for workers' compensation insurance.
• Exemptdesc(optional): string
  Maximum Length: 500

  This field indicates description of workers' compensation exemption.
• Exemptlongdesc(optional): string
  This field indicates the long description of workers' compensation exemption.
• ExpireDate(optional): string(date)
  This field indicates the expiry date of the policy or bond on the license.
• InsuranceFactRec(optional): string
  Maximum Length: 30

  This field indicates the type of insurance associated with state license.
• InsuranceType(optional): string
  Title: Insurance Type

  Maximum Length: 30

  This field indicates the type of insurance on license.
• InsurerAmt(optional): integer(int64)
  This field indicates the coverage amount on the bond or policy on the license.
• InsurerCode(optional): string
  Maximum Length: 30

  This field indicates the code associated with insurer on license.
• InsurerLink(optional): string
  Maximum Length: 500

  The additional URL link to drill into insurer details.
• InsurerName(optional): string
  Maximum Length: 360

  This field indicates the name of insurer on contractor license.
• InsurerPolicyNo(optional): string
  Maximum Length: 30

  This field indicates the policy number issued by the insurer on license.
• IntegrationSource(optional): string
  Maximum Length: 30

  This field Identifies the 3rd party integration.
• IntentToSuspendDate(optional): string(date)
  This field indicates the intent to suspend policy notice date.
• IntLastUpdDt(optional): string(date)
  Title: Last Updated Date

  This field indicates the date last updated by the 3rd party's system.
• IssueDate(optional): string(date)
  This field indicates the issue date of the policy or bond on the license.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  This field indicates the date and time of the last update of the row.
• LicenseInsuranceKey(optional): integer(int64)
  The system generated number used uniquely to identify the license.
• LicensePercentage(optional): integer(int32)
  This field indicates the percentage of voting stock in the company.
• LicQualifierName(optional): string
  Maximum Length: 360

  This field indicates the name of the qualifying individual on bond.
• LicQualifierNameType(optional): string
  Maximum Length: 20

  This field indicates the type of qualifier bond on bond.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpLicenseInsKey(optional): integer(int64)
  This field Indicates the unique identifier of the license for the transaction.
• LnpLicenseKey(optional): integer(int64)
  Title: License Number

  This field indicates the unique identifier of the license transaction.
• LnpRecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  This field indicates the meaningful transaction identifier.
• LnpRecordKey(optional): integer(int64)
  Title: Record ID

  The unique identifier for the related transaction.
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  The system attribute that captures the incremental version number for an object.
• RenewalDate(optional): string(date)
  This field indicates the renewal date of the policy or bond on the license.
• SuspendDate(optional): string(date)
  This field indicates the suspension date of the policy or bond on the license.

{
    "properties":{
        "CancelDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the cancellation date of the policy or bond on the license."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"This indicates the date and time of the creation of the row.",
            "title":"Creation Date"
        },
        "Exempt":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the contractor is exempt for workers' compensation insurance."
        },
        "Exemptdesc":{
            "maxLength":500,
            "type":"string",
            "description":"This field indicates description of workers' compensation exemption."
        },
        "Exemptlongdesc":{
            "type":"string",
            "description":"This field indicates the long description of workers' compensation exemption."
        },
        "ExpireDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the expiry date of the policy or bond on the license."
        },
        "InsuranceFactRec":{
            "maxLength":30,
            "type":"string",
            "description":"This field indicates the type of insurance associated with state license."
        },
        "InsuranceType":{
            "maxLength":30,
            "type":"string",
            "description":"This field indicates the type of insurance on license.",
            "title":"Insurance Type"
        },
        "InsurerAmt":{
            "format":"int64",
            "type":"integer",
            "description":"This field indicates the coverage amount on the bond or policy on the license."
        },
        "InsurerCode":{
            "maxLength":30,
            "type":"string",
            "description":"This field indicates the code associated with insurer on license."
        },
        "InsurerLink":{
            "maxLength":500,
            "type":"string",
            "description":"The additional URL link to drill into insurer details."
        },
        "InsurerName":{
            "maxLength":360,
            "type":"string",
            "description":"This field indicates the name of insurer on contractor license."
        },
        "InsurerPolicyNo":{
            "maxLength":30,
            "type":"string",
            "description":"This field indicates the policy number issued by the insurer on license."
        },
        "IntLastUpdDt":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the date last updated by the 3rd party's system.",
            "title":"Last Updated Date"
        },
        "IntegrationSource":{
            "maxLength":30,
            "type":"string",
            "description":"This field Identifies the 3rd party integration."
        },
        "IntentToSuspendDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the intent to suspend policy notice date."
        },
        "IssueDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the issue date of the policy or bond on the license."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"This field indicates the date and time of the last update of the row.",
            "title":"Last Updated Date"
        },
        "LicQualifierName":{
            "maxLength":360,
            "type":"string",
            "description":"This field indicates the name of the qualifying individual on bond."
        },
        "LicQualifierNameType":{
            "maxLength":20,
            "type":"string",
            "description":"This field indicates the type of qualifier bond on bond."
        },
        "LicenseInsuranceKey":{
            "format":"int64",
            "type":"integer",
            "description":"The system generated number used uniquely to identify the license."
        },
        "LicensePercentage":{
            "format":"int32",
            "type":"integer",
            "description":"This field indicates the percentage of voting stock in the company."
        },
        "LnpLicenseInsKey":{
            "format":"int64",
            "type":"integer",
            "description":"This field Indicates the unique identifier of the license for the transaction."
        },
        "LnpLicenseKey":{
            "format":"int64",
            "type":"integer",
            "description":"This field indicates the unique identifier of the license transaction.",
            "title":"License Number"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"This field indicates the meaningful transaction identifier.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the related transaction.",
            "title":"Record ID"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The system attribute that captures the incremental version number for an object.",
            "title":"Object Version Number"
        },
        "RenewalDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the renewal date of the policy or bond on the license."
        },
        "SuspendDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the suspension date of the policy or bond on the license."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorRecords-RecordContractorLicense-RecordContractorLicInsurance-item

Type: object

Show Source

• CancelDate(optional): string(date)
  This field indicates the cancellation date of the policy or bond on the license.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  This indicates the date and time of the creation of the row.
• Exempt(optional): string
  Maximum Length: 30

  Indicates whether the contractor is exempt for workers' compensation insurance.
• Exemptdesc(optional): string
  Maximum Length: 500

  This field indicates description of workers' compensation exemption.
• Exemptlongdesc(optional): string
  This field indicates the long description of workers' compensation exemption.
• ExpireDate(optional): string(date)
  This field indicates the expiry date of the policy or bond on the license.
• InsuranceFactRec(optional): string
  Maximum Length: 30

  This field indicates the type of insurance associated with state license.
• InsuranceType(optional): string
  Title: Insurance Type

  Maximum Length: 30

  This field indicates the type of insurance on license.
• InsurerAmt(optional): integer(int64)
  This field indicates the coverage amount on the bond or policy on the license.
• InsurerCode(optional): string
  Maximum Length: 30

  This field indicates the code associated with insurer on license.
• InsurerLink(optional): string
  Maximum Length: 500

  The additional URL link to drill into insurer details.
• InsurerName(optional): string
  Maximum Length: 360

  This field indicates the name of insurer on contractor license.
• InsurerPolicyNo(optional): string
  Maximum Length: 30

  This field indicates the policy number issued by the insurer on license.
• IntegrationSource(optional): string
  Maximum Length: 30

  This field Identifies the 3rd party integration.
• IntentToSuspendDate(optional): string(date)
  This field indicates the intent to suspend policy notice date.
• IntLastUpdDt(optional): string(date)
  Title: Last Updated Date

  This field indicates the date last updated by the 3rd party's system.
• IssueDate(optional): string(date)
  This field indicates the issue date of the policy or bond on the license.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  This field indicates the date and time of the last update of the row.
• LicenseInsuranceKey(optional): integer(int64)
  The system generated number used uniquely to identify the license.
• LicensePercentage(optional): integer(int32)
  This field indicates the percentage of voting stock in the company.
• LicQualifierName(optional): string
  Maximum Length: 360

  This field indicates the name of the qualifying individual on bond.
• LicQualifierNameType(optional): string
  Maximum Length: 20

  This field indicates the type of qualifier bond on bond.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpLicenseInsKey(optional): integer(int64)
  This field Indicates the unique identifier of the license for the transaction.
• LnpLicenseKey(optional): integer(int64)
  Title: License Number

  This field indicates the unique identifier of the license transaction.
• LnpRecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  This field indicates the meaningful transaction identifier.
• LnpRecordKey(optional): integer(int64)
  Title: Record ID

  The unique identifier for the related transaction.
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  The system attribute that captures the incremental version number for an object.
• RenewalDate(optional): string(date)
  This field indicates the renewal date of the policy or bond on the license.
• SuspendDate(optional): string(date)
  This field indicates the suspension date of the policy or bond on the license.

{
    "properties":{
        "CancelDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the cancellation date of the policy or bond on the license."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"This indicates the date and time of the creation of the row.",
            "title":"Creation Date"
        },
        "Exempt":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the contractor is exempt for workers' compensation insurance."
        },
        "Exemptdesc":{
            "maxLength":500,
            "type":"string",
            "description":"This field indicates description of workers' compensation exemption."
        },
        "Exemptlongdesc":{
            "type":"string",
            "description":"This field indicates the long description of workers' compensation exemption."
        },
        "ExpireDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the expiry date of the policy or bond on the license."
        },
        "InsuranceFactRec":{
            "maxLength":30,
            "type":"string",
            "description":"This field indicates the type of insurance associated with state license."
        },
        "InsuranceType":{
            "maxLength":30,
            "type":"string",
            "description":"This field indicates the type of insurance on license.",
            "title":"Insurance Type"
        },
        "InsurerAmt":{
            "format":"int64",
            "type":"integer",
            "description":"This field indicates the coverage amount on the bond or policy on the license."
        },
        "InsurerCode":{
            "maxLength":30,
            "type":"string",
            "description":"This field indicates the code associated with insurer on license."
        },
        "InsurerLink":{
            "maxLength":500,
            "type":"string",
            "description":"The additional URL link to drill into insurer details."
        },
        "InsurerName":{
            "maxLength":360,
            "type":"string",
            "description":"This field indicates the name of insurer on contractor license."
        },
        "InsurerPolicyNo":{
            "maxLength":30,
            "type":"string",
            "description":"This field indicates the policy number issued by the insurer on license."
        },
        "IntLastUpdDt":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the date last updated by the 3rd party's system.",
            "title":"Last Updated Date"
        },
        "IntegrationSource":{
            "maxLength":30,
            "type":"string",
            "description":"This field Identifies the 3rd party integration."
        },
        "IntentToSuspendDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the intent to suspend policy notice date."
        },
        "IssueDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the issue date of the policy or bond on the license."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"This field indicates the date and time of the last update of the row.",
            "title":"Last Updated Date"
        },
        "LicQualifierName":{
            "maxLength":360,
            "type":"string",
            "description":"This field indicates the name of the qualifying individual on bond."
        },
        "LicQualifierNameType":{
            "maxLength":20,
            "type":"string",
            "description":"This field indicates the type of qualifier bond on bond."
        },
        "LicenseInsuranceKey":{
            "format":"int64",
            "type":"integer",
            "description":"The system generated number used uniquely to identify the license."
        },
        "LicensePercentage":{
            "format":"int32",
            "type":"integer",
            "description":"This field indicates the percentage of voting stock in the company."
        },
        "LnpLicenseInsKey":{
            "format":"int64",
            "type":"integer",
            "description":"This field Indicates the unique identifier of the license for the transaction."
        },
        "LnpLicenseKey":{
            "format":"int64",
            "type":"integer",
            "description":"This field indicates the unique identifier of the license transaction.",
            "title":"License Number"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"This field indicates the meaningful transaction identifier.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the related transaction.",
            "title":"Record ID"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The system attribute that captures the incremental version number for an object.",
            "title":"Object Version Number"
        },
        "RenewalDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the renewal date of the policy or bond on the license."
        },
        "SuspendDate":{
            "format":"date",
            "type":"string",
            "description":"This field indicates the suspension date of the policy or bond on the license."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top