Get license insurance information for a contractor license
get
/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.
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 TopResponse
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 : publicSectorContractorLicenses-ContractorLicenseInsurances-item-response
Type:
Show Source
object
-
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.
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.