Get an record contractor license
get
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}
Request
Path Parameters
-
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.
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 : publicSectorPzRecords-RecordContractorLicense-item-response
Type:
Show Source
object
-
AddedAfterSubmit: string
Maximum Length:
1
Default Value:N
This indicates that a contractor license was added after the application was submitted. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first address line on contractor???s license. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line on contractor???s license. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line on contractor???s license. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line on contractor???s license. -
AgencyId: number
Default Value:
1
The agency ID this transaction belongs to. -
ApplicantIsAuthAgentFlag: string
Maximum Length:
1
Default Value:N
This field indicates applicant is the authorized agent for a contractor license. -
BusinessLicense: string
The related business license for the specified license.
-
City: string
Title:
City
Maximum Length:60
The name of the city on contractor???s license. -
ComplaintDiscloureInd: string
Maximum Length:
1
This Indicates whether a complaint has been disclosed against license. -
Contact: string
The contact person for the license.
-
ContractorInUse: string
Maximum Length:
1
Default Value:Y
This indicates if a contractor is still in use for the application. -
Country: string
Title:
Country
Maximum Length:60
The name of the country on contractor???s license. -
County: string
Title:
County
Maximum Length:60
The name of the county on contractor???s license. -
Dba: string
Title:
Doing Business As
Maximum Length:360
The name the contractor is doing business as. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address on contractor???s license. -
Enabled: string
This field indicates whether the license is valid for use.
-
Entity: string
Title:
Ownership Type
Maximum Length:30
The entity identified on the contractor???s license. -
ExpireDate: string
(date)
Title:
Expire Date
The expiration date of contractor???s license. -
InactiveDate: string
(date)
Indicates the date on which the contractor???s license was inactivated.
-
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
This Identifies the 3rd party integration. -
InternalLicenseStatus: string
Title:
Status
Maximum Length:30
This is the Internally assigned status by the agent on the license. -
IntLastUpdateBy: string
Title:
Last Updated By
Maximum Length:64
This Indicates the user who updated record with 3rd party integration data. -
IntLastUpdateDt: string
(date)
Title:
Last Updated Date
This Indicates the date the last user updated with 3rd party integration data. -
IntStatusLastUpdateBy: string
Title:
Last Updated By
Maximum Length:64
This Indicates the user who updated the internal license status. -
IntStatusLastUpdateDt: string
(date)
Title:
Last Updated Date
This Indicates the date when the user updated the internal license status. -
InUseLastUpdateBy: string
Maximum Length:
64
The user who last updated the contractor???s In Use status. -
InUseLastUpdateDate: string
(date)
The date when the contractor???s In Use status was last updated.
-
IssueDate: string
(date)
Title:
Issue Date
The date on which the contractor???s license was issued or in effect. -
LicenseKey: integer
(int64)
Title:
License Number
The system generated number used uniquely to identify the license. -
LicenseLmfPre: string
Maximum Length:
10
The suffix associated with the contractor HIS license number. -
LicenseNumber: string
Title:
License Number
Maximum Length:50
The license number issued by the government or the agency. -
LicenseNumberTwo: string
Title:
License Number
Maximum Length:50
The number portion of the contractor license. -
LicenseSetupCode: string
Title:
License Source
Maximum Length:30
This identifies the setup code that identifies the segment usages on the license. -
LicenseSyncDate: string
(date-time)
This field indicates the date and time when the license was merged with the contractor license file.
-
LicenseType: string
Maximum Length:
30
This Identifies the type of license issued. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpLicenseKey: integer
(int64)
Title:
License Number
The system generated number used uniquely to identify the license on the transaction. -
LnpLicensePuid: string
Maximum Length:
480
The public unique identifier for the license, which is an alternate key used by the CRM Import process. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
This Indicates the meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier for the related transaction. -
Name: string
Title:
Qualifier Name
Maximum Length:360
The name on the contractor???s license. -
Owner: string
Title:
Owner Name
Maximum Length:360
This field indicates the owner name(s) on the contractor???s license. -
PhoneAreaCode: string
Title:
Work Phone Country
Maximum Length:10
This field indicates the phone area code on the contractor???s license. -
PhoneCountryCode: string
Title:
Work Phone Country Code
Maximum Length:10
This field indicates the phone country code on the contractor???s license. -
PhoneExtension: string
Title:
Phone
Maximum Length:20
This field indicates the phone extension on the contractor???s license. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
This field indicates the phone number on the contractor???s license. -
PostalCode: string
Title:
ZIP Code
Maximum Length:60
This attribute indicates the postal code on contractor???s license. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:60
This attribute indicates the postal plus code on contractor???s license. -
Province: string
Title:
Province
Maximum Length:60
This field indicates the name of province on contractor???s license. -
ReactivateDate: string
(date)
This field indicates the reissue or renewal date of contractor???s license.
-
RecordContractorLicFact: array
Record Contractor License Facts
Title:
Record Contractor License Facts
The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates lincense fact information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c. -
RecordContractorLicInsurance: array
Record Contractor License Insurances
Title:
Record Contractor License Insurances
The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates lincense Insurance information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c. -
RecordNumber: string
Maximum Length:
64
The public unique identifier for the permit record that is used by the CRM Import process. -
ReissueDate: string
(date)
Title:
Reissue Date
This field indicates the reissue date of contractor???s license. -
SourceStatus: string
Maximum Length:
100
The source status of the contractor???s license. -
State: string
Title:
State
Maximum Length:60
This field indicates the name of the state on contractor license. -
SubjectId: string
Maximum Length:
30
The attribute used to identify where the data should be displayed. -
SuspendDate: string
(date)
The first date of contract???s license suspension.
-
SyncType: string
Read Only:
true
Maximum Length:30
Identifies whether the contractor license is new or updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Record Contractor License Facts
Type:
array
Title:
Record Contractor License Facts
The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates lincense fact information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : Record Contractor License Insurances
Type:
array
Title:
Record Contractor License Insurances
The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates lincense Insurance information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
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.
Nested Schema : publicSectorPzRecords-RecordContractorLicense-RecordContractorLicFact-item-response
Type:
Show Source
object
-
CntrctrLicFactRec: string
Maximum Length:
30
This Identifies the type of fact record for the data. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
This identifies 3rd party integration. -
IntLastUpdDt: string
(date)
Title:
Last Updated
The date last updated by 3rd party???s system. -
LicenseFactKey: integer
(int64)
The system generated number used uniquely to identify the license.
-
LicenseKey: integer
(int64)
This field Indicates the unique identifier of the license.
-
LicenseNumber: string
Maximum Length:
50
Default Value:The license number issued by the government or the agency. -
LicenseSetupCode: string
Maximum Length:
30
Default Value:The setup code that identifies segments usage on the license. -
LicenseType: string
Maximum Length:
30
Default Value:The type of the license issued. -
LicFactCode: string
Maximum Length:
30
This identifies the code for this fact data. -
LicFactCodeValue: string
Maximum Length:
500
This Identifies the value for this fact data. -
LicFactDate: string
(date)
This Identifies the date for this fact data.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpLicenseFactKey: integer
(int64)
The auto generated number used uniquely to identify the license on the transaction.
-
LnpLicenseFactPuid: string
Maximum Length:
480
The public unique identifier for the license fact, 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 for the 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Links
- RecordContractorLicFact
-
Parameters:
- LnpLicenseKey:
$request.path.LnpLicenseKey
- LnpRecordKey:
$request.path.LnpRecordKey
The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates lincense fact information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c. - LnpLicenseKey:
- RecordContractorLicInsurance
-
Parameters:
- LnpLicenseKey:
$request.path.LnpLicenseKey
- LnpRecordKey:
$request.path.LnpRecordKey
The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates lincense Insurance information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c. - LnpLicenseKey: