Jump to

• Request
• Response

Get all application contractor licenses

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordContractorLicenses

Request

Query Parameters

• 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:
  
  

  • PrimaryKey: Finds a contractor license using the primary key criteria.
    Finder Variables:
    • LnpLicenseKey; integer; The unique identifier of a contractor license.
  • blSearchFinder: Finds the business license application contractor license that matches the specified filter values.
    Finder Variables:
    • value; string; The filter value to be applied while finding the business license application contractor license.
  • simpleSearchFinder: Finds the application contractor license that matches the specified filter values.
    Finder Variables:
    • value; string; The filter value to be applied when finding the application contractor license.
• 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:
  

  • Address1; string; The first address line on the contractor license.
  • Address2; string; The second address line on the contractor license.
  • Address3; string; The third address line on the contractor license.
  • Address4; string; The fourth address line on the contractor license.
  • AgencyId; number; The agency ID for the transaction.
  • Applicant; integer; The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
  • ApplicantIsAuthAgentFlag; string; The applicant who is the authorized agent for a contractor license.
  • AssigneeId; integer; The ID of the planner who is assigned to the application.
  • AssigneeUserid; string; The user ID of the planner who is assigned to the application.
  • BlBusDbaBusinessName; string; The name of the business is Doing Business As.
  • City; string; The city of the address on the contractor license.
  • Classification; string; The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
  • ComplaintDiscloureInd; string; Indicates whether a complaint has been disclosed against license. This attribute is for future use.
  • Country; string; The country on the address of the contractor license.
  • County; string; The county on the address of the contractor license.
  • CurrentTransFlag; string; Indicates that the selected row is the current transaction.
  • Dba; string; The name the contractor is doing business as.
  • Description; string; The record description.
  • EmailAddress; string; The email address on a contractor license.
  • Enabled; string; Indicates whether the license is enabled for use in the application. The default value is Y.
  • Entity; string; 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; The expiration date of a contractor 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 when a contractor license became inactive.
  • IntLastUpdateBy; string; The user who updated the third-party integration data.
  • IntLastUpdateDt; string; The date when the third-party integration data was last updated.
  • IntStatusLastUpdateBy; string; The user who updated the internal license status.
  • IntStatusLastUpdateDt; string; The date when the internal license status was last updated.
  • IntegrationSource; string; The third party that integrates with Oracle to verify contractor licenses.
  • InternalLicenseStatus; string; 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.
  • IssueDate; string; The date when the contractor license was originally issued or went into effect.
  • LicenseKey; integer; The automatically generated number that uniquely identifies the contractor license.
  • LicenseLmfPre; string; The suffix associated with the contractor license number to indicate the Home Improvement Salesperson (HIS) registration number.
  • LicenseNumber; string; The contractor license number issued by the government.
  • LicenseNumberTwo; string; The number portion of the contractor license.
  • LicenseSetupCode; string; The code that identifies which data sections are used for the contractor license.
  • LicenseStatus; string; The overall status of the business license.
  • LicenseSyncDate; string; The date and time when the license was merged with the contractor license file.
  • LicenseSysStatus; string; The predefined system status to which the business license status maps.
  • LicenseType; string; The type of contractor license issued.
  • LnpLicenseKey; integer; The system-generated number used uniquely to identify the license on the transaction.
  • 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 for the related transaction.
  • Name; string; The name on the contractor license.
  • Owner; string; The owner name or names on the contractor license.
  • ParcelAddress1; string; The first address line in the address of the record's primary parcel.
  • ParcelAddress2; string; The second address line in the address of the record's primary parcel.
  • ParcelCity; string; The city in the address of the record's primary parcel.
  • ParcelCountry; string; The country in the address of the record's primary parcel.
  • ParcelPostalCode; string; The postal code in the address of the record's primary parcel.
  • ParcelState; string; The state in the address of the record's primary parcel.
  • ParcelStreetNumber; string; The street number in the address of the record's primary parcel.
  • PersonName; string; The name of the person who completed the application process.
  • PhoneAreaCode; string; The phone area code on the contractor license.
  • PhoneCountryCode; string; The phone country code on the contractor license.
  • PhoneExtension; string; The phone extension on the contractor license.
  • PhoneNumber; string; The phone number on the contractor license.
  • PostalCode; string; The postal code on the address of the contractor license.
  • PostalPlus4Code; string; The postal plus code on the address of the contractor license.
  • Province; string; The province on the address of the contractor license.
  • ReactivateDate; string; The date when a contractor license was reactivated after a period of inactivity.
  • RecordLastUpdateDate; string; The date when the record was last updated.
  • RecordNumber; string; The public unique identifier for the permit record that is used by the CRM import process.
  • RecordType; string; The user-friendly name for the record type.
  • RecordTypeCode; string; The unique alphanumeric code or short name for the record type.
  • RecordTypeId; string; The unique identifier for a record type.
  • ReissueDate; string; The date when a contractor license was reissued, for example, if the entity type has changed.
  • SourceStatus; string; The license status as provided by the third-party licensing body that validated the license information.
  • State; string; The state on the address of the contractor license.
  • Status; string; The record status.
  • Subclassification; string; The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.
  • SubjectId; string; The attribute used to identify where the data should be displayed.
  • SuspendDate; string; The date when a contractor license was suspended.
  • SystemStatus; string; The predefined system status to which the record status maps.
  • Total; string; The total amount of fees for this record.
  • TotalDue; string; The amount of fees that are currently due for this record.
  • TotalPaid; string; The amount paid toward the total fees for this record.
  • VersionType; string; The version of the permit. The values are original, amendment, and renewal.
  • VersionTypeCode; string; Indicates the code value of version type.
• 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 Top

Response

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.

Body ()

Root Schema : publicSectorRecordContractorLicenses

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordContractorLicenses-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Permits",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorRecordContractorLicenses-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordContractorLicenses-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorRecordContractorLicenses-item-response

Type: object

Show Source

• 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.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top