Jump to

• Request
• Response

Update a license insurance information for a contractor license

patch

/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses/{LicenseKey}/child/ContractorLicenseInsurances/{LicenseInsuranceKey}

Request

Path Parameters

• LicenseInsuranceKey(required): integer(int64)
  The unique identifier for a type of insurance that is associated with a contractor license.
• LicenseKey(required): integer(int64)
  The automatically generated number that uniquely identifies the contractor license.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CancelDate: string (date)
  Title: Cancellation Date

  The 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

  The description of workers' compensation exemption.
• Exemptlongdesc: string (byte)
  The long description of workers' compensation exemption.
• ExpireDate: string (date)
  Title: Expiration Date

  The 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

  The coverage amount on a bond or insurance policy on a contractor license.
• InsurerCode: string
  Maximum Length: 30

  The code associated with an insurer on a contractor license.
• InsurerLink: string
  Maximum Length: 500

  The URL that provides access to insurer details.
• InsurerName: string
  Title: Company Name

  Maximum Length: 360

  The name of an insurer on a contractor license.
• InsurerPolicyNo: string
  Title: Policy Number

  Maximum Length: 30

  The policy number issued by an insurer on a contractor license.
• IntegrationSource: string
  Maximum Length: 30

  The external third party that validates contractor license details.
• IntentToSuspendDate: string (date)
  The date of a notice of intent to suspend policy on a contractor license.
• IntLastUpdDt: string (date)
  The date when contractor license details were last updated through integration with a third-party system.
• IssueDate: string (date)
  Title: Effective Date

  The issue date of a policy or bond on a contractor license.
• LicenseNumber: string
  Maximum Length: 50

  Default Value:

  The contractor license number issued by the government or the agency.
• LicensePercentage: integer (int32)
  The bond holder's percentage of voting stock in company.
• LicenseSetupCode: string
  Maximum Length: 30

  Default Value:

  The code identifies which data sections are used for the contractor license.
• LicenseType: string
  Maximum Length: 30

  Default Value:

  The type of the issued contractor license.
• 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)
  The renewal date of a policy or bond on a contractor license.
• SuspendDate: string (date)
  Title: Suspend Date

  The suspension date of a policy or bond on a contractor license.

{
    "type":"object",
    "properties":{
        "ExpireDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true
        },
        "InsurerLink":{
            "maxLength":"500",
            "type":"string",
            "description":"The URL that provides access to insurer details.",
            "nullable":true
        },
        "LicenseNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The contractor license number issued by the government or the agency.",
            "nullable":false,
            "default":" "
        },
        "IntentToSuspendDate":{
            "type":"string",
            "description":"The date of a notice of intent to suspend policy on a contractor license.",
            "format":"date",
            "nullable":true
        },
        "InsuranceType":{
            "title":"Coverage Type",
            "maxLength":"360",
            "type":"string",
            "description":"The type of insurance that is associated with the contractor license.",
            "nullable":true
        },
        "LicensePercentage":{
            "type":"integer",
            "description":"The bond holder's percentage of voting stock in company.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"6"
            }
        },
        "InsuranceFactRec":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of insurance record for the contractor data. Examples of insurance types include contractor bonds and workers' compensation.",
            "nullable":false
        },
        "IntegrationSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The external third party that validates contractor license details.",
            "nullable":true
        },
        "IntLastUpdDt":{
            "type":"string",
            "description":"The date when contractor license details were last updated through integration with a third-party system.",
            "format":"date",
            "nullable":true
        },
        "SuspendDate":{
            "title":"Suspend Date",
            "type":"string",
            "description":"The suspension date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true
        },
        "LicenseType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the issued contractor license.",
            "nullable":false,
            "default":" "
        },
        "InsurerAmt":{
            "title":"Amount",
            "type":"number",
            "description":"The coverage amount on a bond or insurance policy on a contractor license.",
            "nullable":true
        },
        "InsurerCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code associated with an insurer on a contractor license.",
            "nullable":true
        },
        "LicQualifierName":{
            "title":"Qualifier Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the qualifying bond holder.",
            "nullable":true
        },
        "LicQualifierNameType":{
            "maxLength":"20",
            "type":"string",
            "description":"The type of qualifying bond holder.",
            "nullable":true
        },
        "Exemptlongdesc":{
            "type":"string",
            "description":"The long description of workers' compensation exemption.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "InsurerPolicyNo":{
            "title":"Policy Number",
            "maxLength":"30",
            "type":"string",
            "description":"The policy number issued by an insurer on a contractor license.",
            "nullable":true
        },
        "IssueDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"The issue date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true
        },
        "RenewalDate":{
            "type":"string",
            "description":"The renewal date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true
        },
        "LicenseSetupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code identifies which data sections are used for the contractor license.",
            "nullable":false,
            "default":" "
        },
        "CancelDate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"The cancellation date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true
        },
        "Exempt":{
            "title":"Exempt",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the contractor is exempt for workers' compensation insurance.",
            "nullable":true,
            "default":"N"
        },
        "InsurerName":{
            "title":"Company Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of an insurer on a contractor license.",
            "nullable":true
        },
        "Exemptdesc":{
            "title":"Exemption Reason",
            "maxLength":"500",
            "type":"string",
            "description":"The description of workers' compensation exemption.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorContractorLicenses-ContractorLicenseInsurances-item-response

Type: object

Show Source

• CancelDate: string (date)
  Title: Cancellation Date

  The 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

  The description of workers' compensation exemption.
• Exemptlongdesc: string (byte)
  The long description of workers' compensation exemption.
• ExpireDate: string (date)
  Title: Expiration Date

  The 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

  The coverage amount on a bond or insurance policy on a contractor license.
• InsurerCode: string
  Maximum Length: 30

  The code associated with an insurer on a contractor license.
• InsurerLink: string
  Maximum Length: 500

  The URL that provides access to insurer details.
• InsurerName: string
  Title: Company Name

  Maximum Length: 360

  The name of an insurer on a contractor license.
• InsurerPolicyNo: string
  Title: Policy Number

  Maximum Length: 30

  The policy number issued by an insurer on a contractor license.
• IntegrationSource: string
  Maximum Length: 30

  The external third party that validates contractor license details.
• IntentToSuspendDate: string (date)
  The date of a notice of intent to suspend policy on a contractor license.
• IntLastUpdDt: string (date)
  The date when contractor license details were last updated through integration with a third-party system.
• IssueDate: string (date)
  Title: Effective Date

  The 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 or the agency.
• LicensePercentage: integer (int32)
  The bond holder's percentage of voting stock in company.
• LicenseSetupCode: string
  Maximum Length: 30

  Default Value:

  The code identifies which data sections are used for the contractor license.
• LicenseType: string
  Maximum Length: 30

  Default Value:

  The type of the issued contractor license.
• 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)
  The renewal date of a policy or bond on a contractor license.
• SuspendDate: string (date)
  Title: Suspend Date

  The suspension date of a policy or bond on a contractor license.

{
    "type":"object",
    "properties":{
        "ExpireDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerLink":{
            "maxLength":"500",
            "type":"string",
            "description":"The URL that provides access to insurer details.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The contractor license number issued by the government or the agency.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "IntentToSuspendDate":{
            "type":"string",
            "description":"The date of a notice of intent to suspend policy on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InsuranceType":{
            "title":"Coverage Type",
            "maxLength":"360",
            "type":"string",
            "description":"The type of insurance that is associated with the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicensePercentage":{
            "type":"integer",
            "description":"The bond holder's percentage of voting stock in company.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "InsuranceFactRec":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of insurance record for the contractor data. Examples of insurance types include contractor bonds and workers' compensation.",
            "nullable":false,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The external third party that validates contractor license details.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdDt":{
            "type":"string",
            "description":"The date when contractor license details were last updated through integration with a third-party system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendDate":{
            "title":"Suspend Date",
            "type":"string",
            "description":"The suspension date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the issued contractor license.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "InsurerAmt":{
            "title":"Amount",
            "type":"number",
            "description":"The coverage amount on a bond or insurance policy on a contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code associated with an insurer on a contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicQualifierName":{
            "title":"Qualifier Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the qualifying bond holder.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LicQualifierNameType":{
            "maxLength":"20",
            "type":"string",
            "description":"The type of qualifying bond holder.",
            "nullable":true,
            "x-queryable":true
        },
        "Exemptlongdesc":{
            "type":"string",
            "description":"The long description of workers' compensation exemption.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "InsurerPolicyNo":{
            "title":"Policy Number",
            "maxLength":"30",
            "type":"string",
            "description":"The policy number issued by an insurer on a contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseInsuranceKey":{
            "type":"integer",
            "description":"The unique identifier for a type of insurance that is associated with a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"The issue date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "type":"string",
            "description":"The renewal date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code identifies which data sections are used for the contractor license.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "CancelDate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"The cancellation date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Exempt":{
            "title":"Exempt",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the contractor is exempt for workers' compensation insurance.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "InsurerName":{
            "title":"Company Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of an insurer on a contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Exemptdesc":{
            "title":"Exemption Reason",
            "maxLength":"500",
            "type":"string",
            "description":"The description of workers' compensation exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The unique identifier for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top