Get all records of contractor license
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense
Request
Path Parameters
-
LnpRecordKey: integer
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 attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:- PrimaryKey: Finds a contractor license using the primary key criteria. Finder Variables:
- LnpLicenseKey; integer; The unique identifier of a contractor license.
- PrimaryKey: Finds a contractor license using the primary key criteria. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRecords-RecordContractorLicense
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecords-RecordContractorLicense-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The first address line on contractor's license. -
Address2(optional):
string
Maximum Length:
240
The second address line on contractor's license. -
Address3(optional):
string
Title:
Address Line 3
Maximum Length:240
The third address line on contractor's license. -
Address4(optional):
string
Title:
Address Line 4
Maximum Length:240
The fourth address line on contractor's license. -
AgencyId(optional):
number
The agency ID this transaction belongs to.
-
City(optional):
string
Title:
City
Maximum Length:60
The name of the city on contractor's license. -
ComplaintDiscloureInd(optional):
string
Maximum Length:
1
This Indicates whether a complaint has been disclosed against license. -
Country(optional):
string
Maximum Length:
60
The name of the country on contractor's license. -
County(optional):
string
Title:
County
Maximum Length:60
The name of the county on contractor's license. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
This attribute indicates the date and time of the creation of the row. -
Dba(optional):
string
Maximum Length:
360
The name the contractor is doing business as. -
EmailAddress(optional):
string
Maximum Length:
320
The email address on contractor's license. -
Entity(optional):
string
Title:
Ownership Type
Maximum Length:30
The entity identified on the contractor's license. -
ExpireDate(optional):
string(date)
The expiration date of contractor's license.
-
InactiveDate(optional):
string(date)
Indicates the date on which the contractor's license was inactivated.
-
IntegrationSource(optional):
string
Maximum Length:
30
This Identifies the 3rd party integration. -
InternalLicenseStatus(optional):
string
Maximum Length:
30
This is the Internally assigned status by the agent on the license. -
IntLastUpdateBy(optional):
string
Title:
Last Updated By
Maximum Length:64
This Indicates the user who updated record with 3rd party integration data. -
IntLastUpdateDt(optional):
string(date)
Title:
Last Updated Date
This Indicates the date the last user updated with 3rd party integration data. -
IntStatusLastUpdateBy(optional):
string
Title:
Last Updated By
Maximum Length:64
This Indicates the user who updated the internal license status. -
IntStatusLastUpdateDt(optional):
string(date)
Title:
Last Updated Date
This Indicates the date when the user updated the internal license status. -
IssueDate(optional):
string(date)
The date on which the contractor's license was issued or in effect.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
This attribute indicates the date and time of the last update of the row. -
LicenseKey(optional):
integer(int64)
The system generated number used uniquely to identify the license.
-
LicenseLmfPre(optional):
string
Maximum Length:
10
The suffix associated with the contractor HIS license number. -
LicenseNumber(optional):
string
Maximum Length:
30
The license number issued by the government. -
LicenseNumberTwo(optional):
string
Maximum Length:
30
The number portion of the contractor license. -
LicenseSetupCode(optional):
string
Maximum Length:
30
This identifies the setup code that identifies the segment usages on the license. -
LicenseType(optional):
string
Maximum Length:
30
This Identifies the type of license issued. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpLicenseKey(optional):
integer(int64)
The system generated number used uniquely to identify the license on the transaction.
-
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
This Indicates the meaningful transaction identifier. -
LnpRecordKey(optional):
integer(int64)
Title:
Record ID
The unique identifier for the related transaction. -
Name(optional):
string
Maximum Length:
360
The name on the contractor's license. -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
The system attribute that captures the incremental version number for an object. -
Owner(optional):
string
Maximum Length:
360
This field indicates the owner name(s) on the contractor's license. -
PhoneAreaCode(optional):
string
Title:
Work Phone Country
Maximum Length:10
This field indicates the phone area code on the contractor's license. -
PhoneCountryCode(optional):
string
Title:
Work Phone Country Code
Maximum Length:10
This field indicates the phone country code on the contractor's license. -
PhoneExtension(optional):
string
Title:
Phone
Maximum Length:20
This field indicates the phone extension on the contractor's license. -
PhoneNumber(optional):
string
Title:
Phone
Maximum Length:40
This field indicates the phone number on the contractor's license. -
PostalCode(optional):
string
Maximum Length:
60
This attribute indicates the postal code on contractor's license. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 Code
Maximum Length:60
This attribute indicates the postal plus code on contractor's license. -
Province(optional):
string
Title:
Province
Maximum Length:60
This field indicates the name of province on contractor's license. -
ReactivateDate(optional):
string(date)
This field indicates the reissue or renewal date of contractor's license.
-
RecordContractorLicFact(optional):
array RecordContractorLicFacts
Title:
RecordContractorLicFacts
The record contractor license resource is used to view, create, modify, or delete a record contractor license. Note: You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c. -
RecordContractorLicInsurance(optional):
array RecordContractorLicInsurances
Title:
RecordContractorLicInsurances
The record contractor license resource is used to view, create, modify, or delete a record contractor license. Note: You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c. -
ReissueDate(optional):
string(date)
This field indicates the reissue date of contractor's license.
-
SourceStatus(optional):
string
Maximum Length:
100
The source status of the contractor's license. -
State(optional):
string
Title:
State
Maximum Length:60
This field indicates the name of the state on contractor license. -
SubjectId(optional):
string
Maximum Length:
30
The attribute used to identify where the data should be displayed. -
SuspendDate(optional):
string(date)
The first date of contract's license suspension.
Nested Schema : RecordContractorLicFacts
Type:
array
Title:
RecordContractorLicFacts
The record contractor license resource is used to view, create, modify, or delete a record contractor license. Note: You must use the agency's dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : RecordContractorLicInsurances
Type:
array
Title:
RecordContractorLicInsurances
The record contractor license resource is used to view, create, modify, or delete a record 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(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorRecords-RecordContractorLicense-RecordContractorLicFact-item
Type:
Show Source
object
-
CntrctrLicFactRec(optional):
string
Maximum Length:
30
This Identifies the type of fact record for the data. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
This indicates the date and time of creation of the row. -
IntegrationSource(optional):
string
Maximum Length:
30
This identifies 3rd party integration. -
IntLastUpdDt(optional):
string(date)
The date last updated by 3rd party's system.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
This indicates the date and time of the last update of the row. -
LicenseFactKey(optional):
integer(int64)
The system generated number used uniquely to identify the license.
-
LicenseKey(optional):
integer(int64)
This field Indicates the unique identifier of the license.
-
LicFactCode(optional):
string
Maximum Length:
30
This identifies the code for this fact data. -
LicFactCodeValue(optional):
string
Maximum Length:
500
This Identifies the value for this fact data. -
LicFactDate(optional):
string(date)
This Identifies the date for this fact data.
-
links(optional):
array Items
Title:
Items
Link Relations -
LnpLicenseFactKey(optional):
integer(int64)
The auto generated number used uniquely to identify the license on the transaction.
-
LnpLicenseKey(optional):
integer(int64)
This field Indicates the unique identifier of the license transaction.
-
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
This field Indicates the meaningful transaction identifier. -
LnpRecordKey(optional):
integer(int64)
Title:
Record ID
The unique identifier for the related transaction. -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
The system attribute that captures the incremental version number for an object.
Nested Schema : publicSectorRecords-RecordContractorLicense-RecordContractorLicInsurance-item
Type:
Show Source
object
-
CancelDate(optional):
string(date)
This field indicates the cancellation date of the policy or bond on the license.
-
CreationDate(optional):
string(date-time)
Title:
Creation Date
This indicates the date and time of the creation of the row. -
Exempt(optional):
string
Maximum Length:
30
Indicates whether the contractor is exempt for workers' compensation insurance. -
Exemptdesc(optional):
string
Maximum Length:
500
This field indicates description of workers' compensation exemption. -
Exemptlongdesc(optional):
string
This field indicates the long description of workers' compensation exemption.
-
ExpireDate(optional):
string(date)
This field indicates the expiry date of the policy or bond on the license.
-
InsuranceFactRec(optional):
string
Maximum Length:
30
This field indicates the type of insurance associated with state license. -
InsuranceType(optional):
string
Title:
Insurance Type
Maximum Length:30
This field indicates the type of insurance on license. -
InsurerAmt(optional):
number
This field indicates the coverage amount on the bond or policy on the license.
-
InsurerCode(optional):
string
Maximum Length:
30
This field indicates the code associated with insurer on license. -
InsurerLink(optional):
string
Maximum Length:
500
The additional URL link to drill into insurer details. -
InsurerName(optional):
string
Maximum Length:
360
This field indicates the name of insurer on contractor license. -
InsurerPolicyNo(optional):
string
Maximum Length:
30
This field indicates the policy number issued by the insurer on license. -
IntegrationSource(optional):
string
Maximum Length:
30
This field Identifies the 3rd party integration. -
IntentToSuspendDate(optional):
string(date)
This field indicates the intent to suspend policy notice date.
-
IntLastUpdDt(optional):
string(date)
Title:
Last Updated Date
This field indicates the date last updated by the 3rd party's system. -
IssueDate(optional):
string(date)
This field indicates the issue date of the policy or bond on the license.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
This field indicates the date and time of the last update of the row. -
LicenseInsuranceKey(optional):
integer(int64)
The system generated number used uniquely to identify the license.
-
LicensePercentage(optional):
integer(int32)
This field indicates the percentage of voting stock in the company.
-
LicQualifierName(optional):
string
Maximum Length:
360
This field indicates the name of the qualifying individual on bond. -
LicQualifierNameType(optional):
string
Maximum Length:
20
This field indicates the type of qualifier bond on bond. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpLicenseInsKey(optional):
integer(int64)
This field Indicates the unique identifier of the license for the transaction.
-
LnpLicenseKey(optional):
integer(int64)
Title:
License Number
This field indicates the unique identifier of the license transaction. -
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
This field indicates the meaningful transaction identifier. -
LnpRecordKey(optional):
integer(int64)
Title:
Record ID
The unique identifier for the related transaction. -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
The system attribute that captures the incremental version number for an object. -
RenewalDate(optional):
string(date)
This field indicates the renewal date of the policy or bond on the license.
-
SuspendDate(optional):
string(date)
This field indicates the suspension date of the policy or bond on the license.