Jump to

• Request
• Response

Get a contractor license insurance detail

get

/fscmRestApi/resources/11.13.18.05/publicSectorViewContractorLicenseInsurances/{LicenseInsuranceKey}

Request

Path Parameters

• LicenseInsuranceKey(required): integer
  The unique identifier for a type of insurance that is associated with a contractor license.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : publicSectorViewContractorLicenseInsurances-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The agency ID for the transaction.
• CancelDate: string (date)
  Title: Cancellation Date

  Read Only: true

  Cancellation date of a policy or bond on a contractor license.
• Dba: string
  Title: Business Name

  Read Only: true

  Maximum Length: 360

  The name the contractor is doing business as.
• Exempt: string
  Title: Exempt

  Read Only: true

  Maximum Length: 30

  Indicates whether the contractor is exempt for workers compensation insurance.
• Exemptdesc: string
  Title: Exemption Reason

  Read Only: true

  Maximum Length: 500

  Description of workers' compensation exemption.
• Exemptlongdesc: string (byte)
  Read Only: true

  Long description of workers' compensation exemption.
• ExpireDate: string (date)
  Title: Expiration Date

  Read Only: true

  Expiration date of a policy or bond on a contractor license.
• InsuranceFactRec: string
  Title: Insurance Fact Code

  Read Only: true

  Maximum Length: 30

  The type of insurance record for the contractor data. Examples of insurance types include contractor bonds and workers compensation.
• InsuranceFactType: string
  Title: Insurance Fact Type

  Read Only: true

  Maximum Length: 100

  The description of a specific contractor license fact within a fact section.
• InsuranceType: string
  Title: Insurance Type

  Read Only: true

  Maximum Length: 360

  The type of insurance that is associated with the contractor license.
• InsurerAmt: number
  Title: Amount

  Read Only: true

  Coverage amount on bond or insurance policy on a contractor license.
• InsurerCode: string
  Read Only: true

  Maximum Length: 30

  Code associated with an insurer on a contractor license.
• InsurerLink: string
  Read Only: true

  Maximum Length: 500

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

  Read Only: true

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 30

  Policy number issued by an insurer on a contractor license.
• IntegrationSource: string
  Read Only: true

  Maximum Length: 30

  Identifies an external third party that validates contractor license facts.
• IntentToSuspendDate: string (date)
  Read Only: true

  Date of a notice of intent to suspend policy on a contractor license.
• InternalLicenseStatus: string
  Title: License Status

  Read Only: true

  Maximum Length: 30

  The license status that is assigned by agency staff. This is an internally maintained status that is not related to the status maintained by the licensing organization.
• IntLastUpdDt: string (date)
  Read Only: true

  Date that contractor license facts were last updated through integration with a third party system.
• IssueDate: string (date)
  Title: Effective Date

  Read Only: true

  Issue date of a policy or bond on a contractor license.
• LicenseInsuranceKey: integer
  Read Only: true

  The unique identifier for a type of insurance that is associated with a contractor license.
• LicenseKey: integer (int64)
  Read Only: true

  The unique identifier for a contractor license.
• LicenseNumber: string
  Read Only: true

  Maximum Length: 50

  The contractor license number issued by the government or the agency.
• LicensePercentage: integer (int32)
  Read Only: true

  The bond holder's percentage of voting stock in the company.
• LicenseSetupCode: string
  Read Only: true

  Maximum Length: 30

  The code identifies which data sections are used for the contractor license.
• LicenseType: string
  Read Only: true

  Maximum Length: 30

  The type of the issued contractor license.
• LicQualifierName: string
  Title: Qualifier Name

  Read Only: true

  Maximum Length: 360

  The name of the qualifying bond holder.
• LicQualifierNameType: string
  Read Only: true

  Maximum Length: 20

  The type of qualifying bond holder.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Number to identify the object version of the record.
• Owner: string
  Title: Owner Name

  Read Only: true

  Maximum Length: 360

  The owner name or names on the contractor license.
• RenewalDate: string (date)
  Read Only: true

  Renewal date of a policy or bond on a contractor license.
• SuspendDate: string (date)
  Title: Suspend Date

  Read Only: true

  Suspension date of a policy or bond on a contractor license.

{
    "type":"object",
    "properties":{
        "Dba":{
            "title":"Business Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name the contractor is doing business as.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner Name",
            "maxLength":"360",
            "type":"string",
            "description":"The owner name or names on the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalLicenseStatus":{
            "title":"License Status",
            "maxLength":"30",
            "type":"string",
            "description":"The license status that is assigned by agency staff. This is an internally maintained status that is not related to the status maintained by the licensing organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpireDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency ID for the transaction.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "InsurerLink":{
            "maxLength":"500",
            "type":"string",
            "description":"URL that provides access to insurer details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The contractor license number issued by the government or the agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InsuranceFactType":{
            "title":"Insurance Fact Type",
            "maxLength":"100",
            "type":"string",
            "description":"The description of a specific contractor license fact within a fact section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntentToSuspendDate":{
            "type":"string",
            "description":"Date of a notice of intent to suspend policy on a contractor license.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InsuranceType":{
            "title":"Insurance Type",
            "maxLength":"360",
            "type":"string",
            "description":"The type of insurance that is associated with the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicensePercentage":{
            "type":"integer",
            "description":"The bond holder's percentage of voting stock in the company.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "InsuranceFactRec":{
            "title":"Insurance Fact Code",
            "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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":"30",
            "type":"string",
            "description":"Identifies an external third party that validates contractor license facts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntLastUpdDt":{
            "type":"string",
            "description":"Date that contractor license facts were last updated through integration with a third party system.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuspendDate":{
            "title":"Suspend Date",
            "type":"string",
            "description":"Suspension date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the issued contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InsurerAmt":{
            "title":"Amount",
            "type":"number",
            "description":"Coverage amount on bond or insurance policy on a contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number to identify the object version of the record.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "InsurerCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code associated with an insurer on a contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicQualifierName":{
            "title":"Qualifier Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the qualifying bond holder.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "Exemptlongdesc":{
            "type":"string",
            "description":"Long description of workers' compensation exemption.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InsurerPolicyNo":{
            "title":"Policy Number",
            "maxLength":"30",
            "type":"string",
            "description":"Policy number issued by an insurer on a contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseInsuranceKey":{
            "type":"integer",
            "description":"The unique identifier for a type of insurance that is associated with a contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Issue date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "type":"string",
            "description":"Renewal date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code identifies which data sections are used for the contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelDate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"Cancellation date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Exempt":{
            "title":"Exempt",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the contractor is exempt for workers compensation insurance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InsurerName":{
            "title":"Company Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of an insurer on a contractor license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Exemptdesc":{
            "title":"Exemption Reason",
            "maxLength":"500",
            "type":"string",
            "description":"Description of workers' compensation exemption.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The unique identifier for a contractor license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "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