Get an application contractor license
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordContractorLicenses/{LnpLicenseKey}
Request
Path Parameters
-
LnpLicenseKey(required): integer(int64)
The system-generated number used uniquely to identify the license on the transaction.
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:
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.
Root Schema : publicSectorRecordContractorLicenses-item-response
Type:
Show Source
object
-
AddedAfterSubmit: string
Read Only:
true
Maximum Length:255
Indicates that the contractor license was added after application submittal. -
Address1: string
Read Only:
true
Maximum Length:240
The first address line on the contractor license. -
Address2: string
Read Only:
true
Maximum Length:240
The second address line on the contractor license. -
Address3: string
Read Only:
true
Maximum Length:240
The third address line on the contractor license. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth address line on the contractor license. -
AgencyId: number
Read Only:
true
The agency ID for the transaction. -
Applicant: integer
(int64)
Read Only:
true
The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit. -
ApplicantIsAuthAgentFlag: string
Read Only:
true
Maximum Length:1
The applicant who is the authorized agent for a contractor license. -
AssigneeId: integer
(int64)
Read Only:
true
The ID of the planner who is assigned to the application. -
AssigneeUserid: string
Read Only:
true
Maximum Length:64
The user ID of the planner who is assigned to the application. -
BlBusDbaBusinessName: string
Read Only:
true
Maximum Length:240
The name of the business is Doing Business As. -
City: string
Read Only:
true
Maximum Length:60
The city of the address on the contractor license. -
Classification: string
Read Only:
true
Maximum Length:3
The record classification. The classifications can be permit, business license, professional license, or planning and zoning. -
ComplaintDiscloureInd: string
Read Only:
true
Maximum Length:1
Indicates whether a complaint has been disclosed against license. This attribute is for future use. -
ContractorInUse: string
Read Only:
true
Maximum Length:1
Indicates whether the contractor is used for the application. The default value is Y. -
Country: string
Read Only:
true
Maximum Length:60
The country on the address of the contractor license. -
County: string
Read Only:
true
Maximum Length:60
The county on the address of the contractor license. -
CurrentTransFlag: string
Read Only:
true
Maximum Length:1
Indicates that the selected row is the current transaction. -
Dba: string
Read Only:
true
Maximum Length:360
The name the contractor is doing business as. -
Description: string
Read Only:
true
Maximum Length:1000
The record description. -
EmailAddress: string
Read Only:
true
Maximum Length:320
The email address on a contractor license. -
Enabled: string
Read Only:
true
Maximum Length:1
Indicates whether the license is enabled for use in the application. The default value is Y. -
Entity: string
Read Only:
true
Maximum Length:30
The type of entity that holds the contractor license. For example, the license can be held by a corporation, partnership, or sole proprietor. -
ExpireDate: string
(date)
Read Only:
true
The expiration date of a contractor license. -
InactiveDate: string
(date)
Read Only:
true
The date when a contractor license became inactive. -
IntegrationSource: string
Read Only:
true
Maximum Length:30
The third party that integrates with Oracle to verify contractor licenses. -
InternalLicenseStatus: string
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. -
IntLastUpdateBy: string
Read Only:
true
Maximum Length:64
The user who updated the third-party integration data. -
IntLastUpdateDt: string
(date)
Read Only:
true
The date when the third-party integration data was last updated. -
IntStatusLastUpdateBy: string
Read Only:
true
Maximum Length:64
The user who updated the internal license status. -
IntStatusLastUpdateDt: string
(date)
Read Only:
true
The date when the internal license status was last updated. -
InUseLastUpdateBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contractor???s in use status. -
InUseLastUpdateDate: string
(date)
Read Only:
true
The date when the contractor???s in use status was last updated. -
IssueDate: string
(date)
Read Only:
true
The date when the contractor license was originally issued or went into effect. -
LicenseKey: integer
(int64)
Read Only:
true
The automatically generated number that uniquely identifies the contractor license. -
LicenseLmfPre: string
Read Only:
true
Maximum Length:10
The suffix associated with the contractor license number to indicate the Home Improvement Salesperson (HIS) registration number. -
LicenseNumber: string
Read Only:
true
Maximum Length:30
The contractor license number issued by the government. -
LicenseNumberTwo: string
Read Only:
true
Maximum Length:30
The number portion of the contractor license. -
LicenseSetupCode: string
Read Only:
true
Maximum Length:30
The code that identifies which data sections are used for the contractor license. -
LicenseStatus: string
Read Only:
true
Maximum Length:30
The overall status of the business license. -
LicenseSyncDate: string
(date-time)
Read Only:
true
The date and time when the license was merged with the contractor license file. -
LicenseSysStatus: string
Read Only:
true
Maximum Length:15
The predefined system status to which the business license status maps. -
LicenseType: string
Read Only:
true
Maximum Length:30
The type of contractor license issued. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpLicenseKey: integer
(int64)
Read Only:
true
The system-generated number used uniquely to identify the license on the transaction. -
LnpLicensePuid: string
Read Only:
true
Maximum Length:480
The public unique identifier for the license, which is an alternate key used by the CRM import process. -
LnpRecordId: string
Read Only:
true
Maximum Length:50
The meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Read Only:
true
The unique identifier for the related transaction. -
Name: string
Read Only:
true
Maximum Length:360
The name on the contractor license. -
Owner: string
Read Only:
true
Maximum Length:360
The owner name or names on the contractor license. -
ParcelAddress1: string
Read Only:
true
Maximum Length:240
The first address line in the address of the record's primary parcel. -
ParcelAddress2: string
Read Only:
true
Maximum Length:240
The second address line in the address of the record's primary parcel. -
ParcelCity: string
Read Only:
true
Maximum Length:60
The city in the address of the record's primary parcel. -
ParcelCountry: string
Read Only:
true
Maximum Length:60
The country in the address of the record's primary parcel. -
ParcelPostalCode: string
Read Only:
true
Maximum Length:60
The postal code in the address of the record's primary parcel. -
ParcelState: string
Read Only:
true
Maximum Length:60
The state in the address of the record's primary parcel. -
ParcelStreetNumber: string
Read Only:
true
Maximum Length:20
The street number in the address of the record's primary parcel. -
PersonName: string
Read Only:
true
Maximum Length:450
The name of the person who completed the application process. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:10
The phone area code on the contractor license. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
The phone country code on the contractor license. -
PhoneExtension: string
Read Only:
true
Maximum Length:20
The phone extension on the contractor license. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
The phone number on the contractor license. -
PostalCode: string
Read Only:
true
Maximum Length:60
The postal code on the address of the contractor license. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:60
The postal plus code on the address of the contractor license. -
Province: string
Read Only:
true
Maximum Length:60
The province on the address of the contractor license. -
ReactivateDate: string
(date)
Read Only:
true
The date when a contractor license was reactivated after a period of inactivity. -
RecordLastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
RecordNumber: string
Read Only:
true
Maximum Length:64
The public unique identifier for the permit record that is used by the CRM import process. -
RecordType: string
Read Only:
true
Maximum Length:100
The user-friendly name for the record type. -
RecordTypeCode: string
Read Only:
true
Maximum Length:20
The unique alphanumeric code or short name for the record type. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The unique identifier for a record type. -
ReissueDate: string
(date)
Read Only:
true
The date when a contractor license was reissued, for example, if the entity type has changed. -
SourceStatus: string
Read Only:
true
Maximum Length:100
The license status as provided by the third-party licensing body that validated the license information. -
State: string
Read Only:
true
Maximum Length:60
The state on the address of the contractor license. -
Status: string
Read Only:
true
Maximum Length:15
The record status. -
Subclassification: string
Read Only:
true
Maximum Length:10
The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process. -
SubjectId: string
Read Only:
true
Maximum Length:30
The attribute used to identify where the data should be displayed. -
SuspendDate: string
(date)
Read Only:
true
The date when a contractor license was suspended. -
SystemStatus: string
Read Only:
true
Maximum Length:15
The predefined system status to which the record status maps. -
Total: string
Read Only:
true
Maximum Length:64
The total amount of fees for this record. -
TotalDue: string
Read Only:
true
Maximum Length:64
The amount of fees that are currently due for this record. -
TotalPaid: string
Read Only:
true
Maximum Length:64
The amount paid toward the total fees for this record. -
VersionType: string
Read Only:
true
Maximum Length:1
The version of the permit. The values are original, amendment, and renewal. -
VersionTypeCode: string
Read Only:
true
Maximum Length:1
Indicates the code value of version type.
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.