Get all contractor licenses
get
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/RecordContractorLicense
Request
Path Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- LnpLicensePuidKey: Finds a contractor license using the public unique identifier key criteria.
Finder Variables:- LnpLicensePuid; string; The unique identifier of a contractor license that is used during the CRM import process.
- PrimaryKey: Finds a contractor license using the primary key criteria.
Finder Variables:- LnpLicenseKey; integer; The unique identifier of a contractor license.
- LnpLicensePuidKey: Finds a contractor license using the public unique identifier key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AddedAfterSubmit; string; Indicates whether a contractor license was added after the application was submitted.
- Address1; string; The first address line on the contractor???s license.
- Address2; string; The second address line on the contractor???s license.
- Address3; string; The third address line on the contractor???s license.
- Address4; string; The fourth address line on the contractor???s license.
- AgencyId; number; The agency ID of the transaction.
- ApplicantIsAuthAgentFlag; string; Indicates whether an applicant is the authorized agent for a contractor license.
- City; string; The name of the city on the contractor???s license.
- ComplaintDiscloureInd; string; Indicates whether a complaint has been disclosed against the license.
- ContractorInUse; string; Indicates whether a contractor is still in use for the application.
- Country; string; The name of the country on the contractor???s license.
- County; string; The name of the county on the contractor???s license.
- Dba; string; The name the contractor is who is doing the business.
- EmailAddress; string; The email address on the contractor???s license.
- Entity; string; The ownership type of the contractor's business.
- ExpireDate; string; The expiration date of the contractor???s license.
- InUseLastUpdateBy; string; The user who last updated the contractor???s In Use status.
- InUseLastUpdateDate; string; The date when the contractor???s In Use status was last updated.
- InactiveDate; string; The date on which the contractor???s license was inactivated.
- IntLastUpdateBy; string; The user who last updated the record with the third party integration data.
- IntLastUpdateDt; string; The date when the user last updated contractor license with the third party integration data.
- IntStatusLastUpdateBy; string; The user who last updated the internal license status.
- IntStatusLastUpdateDt; string; The date when the user last updated the internal license status.
- IntegrationSource; string; The external source of the contractor license integration.
- InternalLicenseStatus; string; The internally assigned license status by the agency.
- IssueDate; string; The date on which the contractor???s license was issued or in effect.
- LicenseKey; integer; The system generated unique number used to identify the license.
- LicenseLmfPre; string; The suffix associated with the contractor HIS license number.
- LicenseNumber; string; The license number issued by the government or the agency.
- LicenseNumberTwo; string; The number portion of the contractor license.
- LicenseSetupCode; string; The setup code that identifies the segment usage on the license.
- LicenseSyncDate; string; The date and time when the license was merged with the contractor license file.
- LicenseType; string; The type of the license issued.
- LnpLicenseKey; integer; The system generated unique number used to identify the transaction license.
- LnpLicensePuid; string; The public unique identifier for the license, which is an alternate key used by the CRM Import process.
- LnpRecordId; string; The meaningful transaction identifier.
- LnpRecordKey; integer; The unique identifier of the related transaction.
- Name; string; The name on the contractor???s license.
- Owner; string; The owner name(s) on the contractor???s license.
- PhoneAreaCode; string; The phone area code on the contractor???s license.
- PhoneCountryCode; string; The phone country code on the contractor???s license.
- PhoneExtension; string; The phone extension on the contractor???s license.
- PhoneNumber; string; The phone number on the contractor???s license.
- PostalCode; string; The postal code on the contractor???s license.
- PostalPlus4Code; string; The postal plus code on the contractor???s license.
- Province; string; The name of province on the contractor???s license.
- ReactivateDate; string; The reissue or renewal date of the contractor???s license.
- RecordNumber; string; The public unique identifier for the permit record that is used by the CRM Import process.
- ReissueDate; string; The reissue date of the contractor???s license.
- SourceStatus; string; The source status of the contractor???s license.
- State; string; The name of the state on contractor's license.
- SubjectId; string; Used to identify where the data should be displayed.
- SuspendDate; string; The first date of contract???s license suspension.
- SyncType; string; Identifies whether the contractor license is new or updated.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : publicSectorBlRecords-RecordContractorLicense
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBlRecords-RecordContractorLicense-item-response
Type:
Show Source
object
-
AddedAfterSubmit: string
Maximum Length:
1
Default Value:N
Indicates whether a contractor license was added after the application was submitted. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first address line on the contractor???s license. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line on the contractor???s license. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line on the contractor???s license. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line on the contractor???s license. -
AgencyId: number
Default Value:
1
The agency ID of the transaction. -
ApplicantIsAuthAgentFlag: string
Maximum Length:
1
Default Value:N
Indicates whether an applicant is the authorized agent for a contractor license. -
BusinessLicense: string
-
City: string
Title:
City
Maximum Length:60
The name of the city on the contractor???s license. -
ComplaintDiscloureInd: string
Maximum Length:
1
Indicates whether a complaint has been disclosed against the license. -
Contact: string
-
ContractorInUse: string
Maximum Length:
1
Default Value:Y
Indicates whether a contractor is still in use for the application. -
Country: string
Title:
Country
Maximum Length:60
The name of the country on the contractor???s license. -
County: string
Title:
County
Maximum Length:60
The name of the county on the contractor???s license. -
Dba: string
Title:
Doing Business As
Maximum Length:360
The name the contractor is who is doing the business. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address on the contractor???s license. -
Enabled: string
Indicates whether the license is valid for use.
-
Entity: string
Title:
Ownership Type
Maximum Length:30
The ownership type of the contractor's business. -
ExpireDate: string
(date)
Title:
Expire Date
The expiration date of the contractor???s license. -
InactiveDate: string
(date)
The date on which the contractor???s license was inactivated.
-
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
The external source of the contractor license integration. -
InternalLicenseStatus: string
Title:
Status
Maximum Length:30
The internally assigned license status by the agency. -
IntLastUpdateBy: string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record with the third party integration data. -
IntLastUpdateDt: string
(date)
Title:
Last Updated Date
The date when the user last updated contractor license with the third party integration data. -
IntStatusLastUpdateBy: string
Title:
Last Updated By
Maximum Length:64
The user who last updated the internal license status. -
IntStatusLastUpdateDt: string
(date)
Title:
Last Updated Date
The date when the user last 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 unique number used 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
The setup code that identifies the segment usage on the license. -
LicenseSyncDate: string
(date-time)
The date and time when the license was merged with the contractor license file.
-
LicenseType: string
Maximum Length:
30
The type of the license issued. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpLicenseKey: integer
(int64)
Title:
License Number
The system generated unique number used to identify the transaction license. -
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
The meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier of 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
The owner name(s) on the contractor???s license. -
PhoneAreaCode: string
Title:
Work Phone Country
Maximum Length:10
The phone area code on the contractor???s license. -
PhoneCountryCode: string
Title:
Work Phone Country Code
Maximum Length:10
The phone country code on the contractor???s license. -
PhoneExtension: string
Title:
Phone
Maximum Length:20
The phone extension on the contractor???s license. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The phone number on the contractor???s license. -
PostalCode: string
Title:
ZIP Code
Maximum Length:60
The postal code on the contractor???s license. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:60
The postal plus code on the contractor???s license. -
Province: string
Title:
Province
Maximum Length:60
The name of province on the contractor???s license. -
ReactivateDate: string
(date)
The reissue or renewal date of the 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 license fact information associated with contractor license. 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 license Insurance information associated with contractor license. 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
The reissue date of the contractor???s license. -
SourceStatus: string
Maximum Length:
100
The source status of the contractor???s license. -
State: string
Title:
State
Maximum Length:60
The name of the state on contractor's license. -
SubjectId: string
Maximum Length:
30
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 license fact information associated with contractor license. 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 license Insurance information associated with contractor license. 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 : publicSectorBlRecords-RecordContractorLicense-RecordContractorLicFact-item-response
Type:
Show Source
object
-
CntrctrLicFactRec: string
Maximum Length:
30
The type of fact record for the data. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
The third party integration. -
IntLastUpdDt: string
(date)
Title:
Last Updated
The date last updated by third party???s system. -
LicenseFactKey: integer
(int64)
The system generated unique number used to identify the license.
-
LicenseKey: integer
(int64)
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:Setup code identifying segments usage on the license. -
LicenseType: string
Maximum Length:
30
Default Value:The type of the license issued -
LicFactCode: string
Maximum Length:
30
The code for this fact data. -
LicFactCodeValue: string
Maximum Length:
500
The value for this fact data. -
LicFactDate: string
(date)
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 unique number used to identify the license 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
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
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 : publicSectorBlRecords-RecordContractorLicense-RecordContractorLicInsurance-item-response
Type:
Show Source
object
-
CancelDate: string
(date)
Title:
Cancellation Date
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 from 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:
Expire Date
The expiry date of the policy or bond on the license. -
InsuranceFactRec: string
Maximum Length:
30
The type of insurance associated with the state license. -
InsuranceType: string
Title:
Insurance Type
Maximum Length:360
The type of insurance on the license. -
InsurerAmt: number
Title:
Amount
The coverage amount on the bond or policy on the license. -
InsurerCode: string
Title:
Code
Maximum Length:30
The code associated with an insurer on the license. -
InsurerLink: string
Maximum Length:
500
The additional URL link to drill into insurer details. -
InsurerName: string
Title:
Company Name
Maximum Length:360
The name of insurer on the contractor license. -
InsurerPolicyNo: string
Title:
Policy Number
Maximum Length:30
The policy number issued by the insurer on the license. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
The third party integration source. -
IntentToSuspendDate: string
(date)
The intent to suspend policy notice date.
-
IntLastUpdDt: string
(date)
Title:
Last Updated Date
The date when the third party system was last updated. -
IssueDate: string
(date)
Title:
Issue Date
The issue date of the policy or bond on the license. -
LicenseInsuranceKey: integer
(int64)
The system generated unique number used to identify the license.
-
LicenseNumber: string
Maximum Length:
50
The license number issued by the government. -
LicensePercentage: integer
(int32)
The percentage of voting stock in the company.
-
LicenseSetupCode: string
Maximum Length:
30
Default Value:Setup code identifying segments usage on the license. -
LicenseType: string
Maximum Length:
30
The type of the license issued. -
LicQualifierName: string
Title:
Qualifier Name
Maximum Length:360
The name of the qualifying individual on the bond. -
LicQualifierNameType: string
Maximum Length:
20
The type of the qualifier bond. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpLicenseInsKey: integer
(int64)
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
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
The meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier for the related transaction. -
RenewalDate: string
(date)
The renewal date of the policy or bond on the license.
-
SuspendDate: string
(date)
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