Jump to

• Request
• Response

Get all contractor licenses

get

/fscmRestApi/resources/11.13.18.05/publicSectorContractorLicenses

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 the contractor license that matches the primary keys specified.
    Finder Variables:
    • LicenseKey; integer; The contractor license key.
  • simpleSearchFinder: Finds the contractor license that matches the specified filter values.
    Finder Variables:
    • value; string; The filter values to be applied when finding the contractor license information. Filtering options include License Number, Status, Business Name, Address1, Address2, City, State, and Postal Code.
• 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; integer; The agency ID for the transaction.
  • City; string; The city of the address on the contractor license.
  • ComplaintDiscloureInd; string; Indicates whether a complaint has been disclosed against license.
  • ContractorLicenseNumber; string; The number portion of the contractor license.
  • Country; string; The country on the address of the contractor license.
  • County; string; The county on the address of the contractor license.
  • Dba; string; The name the contractor is doing business as.
  • EmailAddress; string; The email address on a contractor license.
  • EnabledFlag; string; Indicates whether the license is enabled for use in the application. The default value is Y.
  • ExpireDate; string; The expiration date of a contractor license.
  • 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.
  • LicenseEntity; string; The type of entity that holds the contractor license. For example, the license can be held by a corporation, partnership, or sole proprietor.
  • 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 or the agency.
  • LicenseSetupCode; string; The code identifies which data sections are used for the contractor license.
  • LicenseType; string; The type of the issued contractor license.
  • Name; string; The name on the contractor license.
  • Owner; string; The owner name or names on the contractor license.
  • 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.
  • PostalPlus4Code; string; The postal 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.
  • ReissueDate; string; The date when a contractor license was reissued, for example, if the entity type has changed.
  • SourceLastUpdateDt; string; The date when the license information was last updated by the third-party licensing body that validated the license information.
  • 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.
  • SuspendDate; string; The date when a contractor license was suspended.
  • UsedInApplication; string; Indicates whether the license is referenced in any applications.
• 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 : publicSectorContractorLicenses

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/publicSectorContractorLicenses-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"TradeLicenseManagement",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorContractorLicenses-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorContractorLicenses-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 : publicSectorContractorLicenses-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first address line on the contractor license.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address line on the contractor license.
• Address3: string
  Maximum Length: 240

  The third address line on the contractor license.
• Address4: string
  Maximum Length: 240

  The fourth address line on the contractor license.
• AgencyId: integer (int32)
  Default Value: 1

  The agency ID for the transaction.
• City: string
  Maximum Length: 60

  The city of the address on the contractor license.
• ComplaintDiscloureInd: string
  Maximum Length: 1

  Indicates whether a complaint has been disclosed against license.
• ContractorLicenseAgents: array Contractor License Agents
  Title: Contractor License Agents

  The contractor license agents resource is used to view, add, delete, and modify details associated with authorized contacts who act as agents for the holder of a contractor license.
• ContractorLicenseFacts: array Contractor License Facts
  Title: Contractor License Facts

  The contractor license facts resource is used to view, add, delete, and modify details pertaining to contractor license information such as classification, certification, status, and so forth.
• ContractorLicenseInsurances: array Contractor License Insurances
  Title: Contractor License Insurances

  The contractor license insurances resource is used to view, add, delete, and modify details pertaining to insurance and workers compensation for a contractor license.
• ContractorLicenseNumber: string
  Maximum Length: 50

  The number portion of the contractor license.
• Country: string
  Title: Country

  Maximum Length: 60

  The country on the address of the contractor license.
• County: string
  Maximum Length: 60

  The county on the address of the contractor license.
• Dba: string
  Title: Business Name

  Maximum Length: 360

  The name the contractor is doing business as.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The email address on a contractor license.
• EnabledFlag: string
  Title: Contractor Approved

  Maximum Length: 1

  Default Value: Y

  Indicates whether the license is enabled for use in the application. The default value is Y.
• ExpireDate: string (date)
  Title: Expire Date

  The expiration date of a contractor license.
• InactiveDate: string (date)
  The date when a contractor license became inactive.
• IntegrationSource: string
  Maximum Length: 30

  The third party that integrates with Oracle to verify contractor licenses.
• InternalLicenseStatus: string
  Title: License Status

  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.
• InternalStatusDescr: string
  Read Only: true

  The description of the internal status for the license.
• IntLastUpdateBy: string
  Maximum Length: 64

  The user who updated the third-party integration data.
• IntLastUpdateDt: string (date)
  The date when the third-party integration data was last updated.
• IntStatusLastUpdateBy: string
  Title: Last Updated

  Maximum Length: 64

  The user who updated the internal license status.
• IntStatusLastUpdateDt: string (date)
  Title: License Last Updated

  The date when the internal license status was last updated.
• IssueDate: string (date)
  Title: Issue Date

  The date when the contractor license was originally issued or went into effect.
• LicenseEntity: string
  Title: Entity

  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.
• LicenseKey: integer (int64)
  The automatically generated number that uniquely identifies the contractor license.
• LicenseLmfPre: string
  Maximum Length: 10

  The suffix associated with the contractor license number to indicate the Home Improvement Salesperson (HIS) registration number.
• LicenseNumber: string
  Title: License Number

  Maximum Length: 50

  The contractor license number issued by the government or the agency.
• LicenseSetupCode: string
  Title: License Source

  Maximum Length: 30

  The code identifies which data sections are used for the contractor license.
• LicenseType: string
  Title: License Type

  Maximum Length: 30

  The type of the issued contractor license.
• LicenseTypeDescr: string
  The description of the contractor license type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Legal Business Name

  Maximum Length: 360

  The name on the contractor license.
• Owner: string
  Title: Owner Name

  Maximum Length: 360

  The owner name or names on the contractor license.
• PhoneAreaCode: string
  Maximum Length: 10

  The phone area code on the contractor license.
• PhoneCountryCode: string
  Maximum Length: 10

  The phone country code on the contractor license.
• PhoneExtension: string
  Maximum Length: 20

  The phone extension on the contractor license.
• PhoneNumber: string
  Maximum Length: 40

  The phone number on the contractor license.
• PostalPlus4Code: string
  Title: ZIP Code

  Maximum Length: 60

  The postal code on the address of the contractor license.
• Province: string
  Maximum Length: 60

  The province on the address of the contractor license.
• ReactivateDate: string (date)
  The date when a contractor license was reactivated after a period of inactivity.
• ReissueDate: string (date)
  Title: Reissue Date

  The date when a contractor license was reissued, for example, if the entity type has changed.
• SourceLastUpdateDt: string (date)
  The date when the license information was last updated by the third-party licensing body that validated the license information.
• SourceStatus: string
  Title: Source Status

  Maximum Length: 100

  The license status as provided by the third-party licensing body that validated the license information.
• State: string
  Maximum Length: 60

  The state on the address of the contractor license.
• SuspendDate: string (date)
  The date when a contractor license was suspended.
• UsedInApplication: string
  Title: Referenced in Application

  Maximum Length: 1

  Default Value: N

  Indicates whether the license is referenced in any applications.

{
    "type":"object",
    "properties":{
        "Dba":{
            "title":"Business Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name the contractor is doing business as.",
            "nullable":false,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner Name",
            "maxLength":"360",
            "type":"string",
            "description":"The owner name or names on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ReissueDate":{
            "title":"Reissue Date",
            "type":"string",
            "description":"The date when a contractor license was reissued, for example, if the entity type has changed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InternalLicenseStatus":{
            "title":"License Status",
            "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,
            "x-queryable":true
        },
        "ExpireDate":{
            "title":"Expire Date",
            "type":"string",
            "description":"The expiration date of a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseNumber":{
            "title":"License Number",
            "maxLength":"50",
            "type":"string",
            "description":"The contractor license number issued by the government or the agency.",
            "nullable":false,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The third party that integrates with Oracle to verify contractor licenses.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Legal Business Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdateDt":{
            "type":"string",
            "description":"The date when the third-party integration data was last updated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IntStatusLastUpdateDt":{
            "title":"License Last Updated",
            "type":"string",
            "description":"The date when the internal license status was last updated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLastUpdateDt":{
            "type":"string",
            "description":"The date when the license information was last updated by the third-party licensing body that validated the license information.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContractorLicenseAgents":{
            "title":"Contractor License Agents",
            "type":"array",
            "description":"The contractor license agents resource is used to view, add, delete, and modify details associated with authorized contacts who act as agents for the holder of a contractor license.",
            "items":{
                "$ref":"#/components/schemas/publicSectorContractorLicenses-ContractorLicenseAgents-item-response"
            }
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"The city of the address on the contractor license.",
            "nullable":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,
            "x-queryable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"The province on the address of the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address on a contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":"20",
            "type":"string",
            "description":"The phone extension on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"ZIP Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code on the address of the contractor license.",
            "nullable":false,
            "x-queryable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The state on the address of the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalStatusDescr":{
            "type":"string",
            "description":"The description of the internal status for the license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"The country on the address of the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency ID for the transaction.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ContractorLicenseFacts":{
            "title":"Contractor License Facts",
            "type":"array",
            "description":"The contractor license facts resource is used to view, add, delete, and modify details pertaining to contractor license information such as classification, certification, status, and so forth.",
            "items":{
                "$ref":"#/components/schemas/publicSectorContractorLicenses-ContractorLicenseFacts-item-response"
            }
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"The county on the address of the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendDate":{
            "type":"string",
            "description":"The date when a contractor license was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseType":{
            "title":"License Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the issued contractor license.",
            "nullable":false,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone country code on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone area code on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplaintDiscloureInd":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a complaint has been disclosed against license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntStatusLastUpdateBy":{
            "title":"Last Updated",
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated the internal license status.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Contractor Approved",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether  the license is enabled for use in the application. The default value is Y.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "ContractorLicenseInsurances":{
            "title":"Contractor License Insurances",
            "type":"array",
            "description":"The contractor license insurances resource is used to view, add, delete, and modify details pertaining to insurance and workers compensation for a contractor license.",
            "items":{
                "$ref":"#/components/schemas/publicSectorContractorLicenses-ContractorLicenseInsurances-item-response"
            }
        },
        "InactiveDate":{
            "type":"string",
            "description":"The date when a contractor license became inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceStatus":{
            "title":"Source Status",
            "maxLength":"100",
            "type":"string",
            "description":"The license status as provided by the third-party licensing body that validated the license information.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third address line on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date when the contractor license was originally issued or went into effect.",
            "format":"date",
            "nullable":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,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first address line on the contractor license.",
            "nullable":false,
            "x-queryable":true
        },
        "UsedInApplication":{
            "title":"Referenced in Application",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the license is referenced in any applications.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "LicenseEntity":{
            "title":"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,
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "title":"License Source",
            "maxLength":"30",
            "type":"string",
            "description":"The code identifies which data sections are used for the contractor license.",
            "nullable":false,
            "x-queryable":true
        },
        "IntLastUpdateBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated the third-party integration data.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseTypeDescr":{
            "type":"string",
            "description":"The description of the contractor license type.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The phone number on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractorLicenseNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The number portion of the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The automatically generated number that uniquely identifies the contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Contractor License Agents

Type: array

Title: Contractor License Agents

The contractor license agents resource is used to view, add, delete, and modify details associated with authorized contacts who act as agents for the holder of a contractor license.

Show Source

• Array of: object publicSectorContractorLicenses-ContractorLicenseAgents-item-response

{
    "title":"Contractor License Agents",
    "type":"array",
    "description":"The contractor license agents resource is used to view, add, delete, and modify details associated with authorized contacts who act as agents for the holder of a contractor license.",
    "items":{
        "$ref":"#/components/schemas/publicSectorContractorLicenses-ContractorLicenseAgents-item-response"
    }
}

Nested Schema : Contractor License Facts

Type: array

Title: Contractor License Facts

The contractor license facts resource is used to view, add, delete, and modify details pertaining to contractor license information such as classification, certification, status, and so forth.

Show Source

• Array of: object publicSectorContractorLicenses-ContractorLicenseFacts-item-response

{
    "title":"Contractor License Facts",
    "type":"array",
    "description":"The contractor license facts resource is used to view, add, delete, and modify details pertaining to contractor license information such as classification, certification, status, and so forth.",
    "items":{
        "$ref":"#/components/schemas/publicSectorContractorLicenses-ContractorLicenseFacts-item-response"
    }
}

Nested Schema : Contractor License Insurances

Type: array

Title: Contractor License Insurances

The contractor license insurances resource is used to view, add, delete, and modify details pertaining to insurance and workers compensation for a contractor license.

Show Source

• Array of: object publicSectorContractorLicenses-ContractorLicenseInsurances-item-response

{
    "title":"Contractor License Insurances",
    "type":"array",
    "description":"The contractor license insurances resource is used to view, add, delete, and modify details pertaining to insurance and workers compensation for a contractor license.",
    "items":{
        "$ref":"#/components/schemas/publicSectorContractorLicenses-ContractorLicenseInsurances-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 : publicSectorContractorLicenses-ContractorLicenseAgents-item-response

Type: object

Show Source

• ActiveLastUpdateBy: string
  Maximum Length: 64

  The user who last updated the active contact status.
• ActiveLastUpdateDate: string (date-time)
  Date when the user last updated the active status of the contact.
• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the address of the person who is a contact for the contractor license.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the address of the person who is a contact for the contractor license.
• Address3: string
  Maximum Length: 240

  The third line of the address of the person who is a contact for the contractor license.
• Address4: string
  Maximum Length: 240

  The fourth line of the address of the person who is a contact for the contractor license.
• AssociateDate: string (date)
  The date when the contact person was associated with the contractor license.
• AuthorizeAgentFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the contact person is an authorized user of the license.
• AuthorizeStatus: string
  Maximum Length: 30

  Default Value: PV

  The status of the contact person who is associated with the contractor license. The status indicates whether the person is a verified contact.
• City: string
  Maximum Length: 60

  The city for the address of the person who is a contact for the contractor license.
• ContactActive: string
  Maximum Length: 1

  Default Value: Y

  The status for the contact person.
• ContactBizPartyId: integer (int64)
  The business party ID associated with the entity that holds the license.
• ContactBizProfileId: integer (int64)
  The business profile ID associated with the contact person if the contact person is a registered user.
• ContactId: string
  Maximum Length: 18

  The contact ID associated with the contact person for the business license. This attribute is not currently used.
• ContactPartyId: integer (int64)
  The party ID associated with the contact person if the contact person is a registered user.
• ContactProfileId: integer (int64)
  The profile ID associated with the contact person if the contact person is a registered user.
• ContactType: string
  Title: Association Type

  Maximum Length: 30

  The contact type or role of the person associated with the license. This attribute is not currently used.
• Country: string
  Title: Country

  Maximum Length: 3

  The country for the address of the person who is a contact for the contractor license.
• County: string
  Maximum Length: 60

  The country for the address of the person who is a contact for the contractor license.
• DisassociateDate: string (date)
  The date when a former contact person was disassociated from the contractor license.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The email address of the person who is a contact for the contractor license.
• JobTitle: string
  Title: Title

  Maximum Length: 60

  The job title of the person who is a contact for the contractor license.
• LicenseAgentKey: integer (int64)
  The unique identifier for the person who is an authorized contact for a contractor license.
• LicenseHolderFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the contact person is a license holder.
• LicenseKey: integer (int64)
  The unique identifier for a contractor license.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationName: string
  Maximum Length: 360

  The name of the organization of the contact person for the contractor license.
• PersonFirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the person who is authorized as a contact for the contractor license.
• PersonLastName: string
  Title: Last Name

  Maximum Length: 150

  Last name of the person who is authorized as a contact for the contractor license.
• PersonMiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the person who is authorized as a contact for the contractor license.
• PersonName: string
  Maximum Length: 450

  The full concatenated name of the person who is authorized as a contact for the contractor license. This includes the person's first, middle, and last names and any name suffix.
• PersonNameSuffix: string
  Title: Suffix

  Maximum Length: 30

  The name suffix for the person who is authorized as a contact for the contractor license.
• PersonPreNameAdjunct: string
  Title: Salutation

  Maximum Length: 30

  The salutation of the person associated with the contractor license.
• PhoneAreaCode: string
  Maximum Length: 10

  The phone area code of the person who is a contact for the contractor license.
• PhoneCountryCode: string
  Maximum Length: 10

  The phone country code of the person who is a contact for the contractor license.
• PhoneExtension: string
  Maximum Length: 20

  The phone extension of the person who is a contact for the contractor license.
• PhoneNumber: string
  Maximum Length: 40

  The phone of the person who is a contact for the contractor license.
• PostalCode: string
  Title: ZIP Code

  Maximum Length: 60

  The postal code for the address of the person who is a contact for the contractor license.
• PrimaryFlag: string
  Maximum Length: 1

  Identifies whether the person associated with the license is the preferred contact for the contractor. This attribute is not currently used.
• Province: string
  Maximum Length: 60

  The province for the address of the person who is a contact for the contractor license.
• State: string
  Maximum Length: 60

  The state for the address of the person who is a contact for the contractor license.
• VerificationDate: string (date)
  The date when the user last updated the authorization status.
• VerifiedBy: string
  Maximum Length: 64

  The user who updated the authorization status.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the organization of the contact person for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationDate":{
            "type":"string",
            "description":"The date when the user last updated the authorization status.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ContactType":{
            "title":"Association Type",
            "maxLength":"30",
            "type":"string",
            "description":"The contact type or role of the person associated with the license. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Identifies whether the person associated with the license is the preferred contact for the contractor. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix for the person who is authorized as a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"ZIP Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the person who is authorized as a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "maxLength":"18",
            "type":"string",
            "description":"The contact ID associated with the contact person for the business license. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactProfileId":{
            "type":"integer",
            "description":"The profile ID associated with the contact person if the contact person is a registered user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The job title of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"The country for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseHolderFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the contact person is a license holder.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "AuthorizeAgentFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the contact person is an authorized user of the license.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "LicenseAgentKey":{
            "type":"integer",
            "description":"The unique identifier for the person who is an authorized contact for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone country code of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone area code of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactBizPartyId":{
            "type":"integer",
            "description":"The business party ID associated with the entity that holds the license.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssociateDate":{
            "type":"string",
            "description":"The date when the contact person was associated with the contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "type":"integer",
            "description":"The party ID associated with the contact person if the contact person is a registered user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonPreNameAdjunct":{
            "title":"Salutation",
            "maxLength":"30",
            "type":"string",
            "description":"The salutation of the person associated with the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactActive":{
            "maxLength":"1",
            "type":"string",
            "description":"The status for the contact person.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "PersonName":{
            "maxLength":"450",
            "type":"string",
            "description":"The full concatenated name of the person who is authorized as a contact for the contractor license. This includes the person's first, middle, and last names and any name suffix.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of the person who is authorized as a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactBizProfileId":{
            "type":"integer",
            "description":"The business profile ID associated with the contact person if the contact person is a registered user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "DisassociateDate":{
            "type":"string",
            "description":"The date when a former contact person was disassociated from the contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person who is authorized as a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"The city for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"The province for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":"20",
            "type":"string",
            "description":"The phone extension of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveLastUpdateBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the active contact  status.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveLastUpdateDate":{
            "type":"string",
            "description":"Date when the user last updated the active status of the contact.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The state for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The phone of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country for the address of the person who is a contact for the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "VerifiedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated the authorization status.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The unique identifier for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AuthorizeStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The status of the contact person who is associated with the contractor license. The status indicates whether the person is a verified contact.",
            "nullable":true,
            "default":"PV",
            "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."
        }
    }
}

Nested Schema : publicSectorContractorLicenses-ContractorLicenseFacts-item-response

Type: object

Show Source

• CntrctrLicFactRec: string
  Maximum Length: 30

  The type of detail record for the contractor data. For example, contractor data for a specific state might include detail sections for Status and Certifications.
• IntegrationSource: string
  Maximum Length: 30

  The external third party that validates a contractor license and its facts.
• IntLastUpdDt: string (date)
  The date when contractor license details were last updated through integration with a third-party system.
• LicenseFactKey: integer (int64)
  The unique identifier for a detail for a contractor license.
• LicenseKey: integer (int64)
  The unique identifier for a contractor license.
• LicenseNumber: string
  Maximum Length: 50

  Default Value:

  The contractor license number issued by the government or the agency.
• LicenseSetupCode: string
  Maximum Length: 30

  Default Value:

  The code identifies which data sections are used for the contractor license.
• LicenseType: string
  Maximum Length: 30

  Default Value:

  The type of the issued contractor license.
• LicFactCode: string
  Title: Code

  Maximum Length: 30

  The code for this detail item.
• LicFactCodeValue: string
  Title: Description

  Maximum Length: 500

  The value for this detail item.
• LicFactDate: string (date)
  Title: Date

  The date for a detail item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LicenseSetupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code identifies which data sections are used for the contractor license.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "LicFactCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for this detail item.",
            "nullable":false,
            "x-queryable":true
        },
        "LicenseNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The contractor license number issued by the government or the agency.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "LicFactCodeValue":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"The value for this detail item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LicenseFactKey":{
            "type":"integer",
            "description":"The unique identifier for a detail for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LicFactDate":{
            "title":"Date",
            "type":"string",
            "description":"The date for a detail item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The external third party that validates a contractor license and its facts.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdDt":{
            "type":"string",
            "description":"The date when contractor license details were last updated through integration with a third-party system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CntrctrLicFactRec":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of detail record for the contractor data. For example, contractor data for a specific state might include detail sections for Status and Certifications.",
            "nullable":false,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The unique identifier for a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the issued contractor license.",
            "nullable":false,
            "default":" ",
            "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 : publicSectorContractorLicenses-ContractorLicenseInsurances-item-response

Type: object

Show Source

• CancelDate: string (date)
  Title: Cancellation Date

  The cancellation date of a policy or bond on a contractor license.
• Exempt: string
  Title: Exempt

  Maximum Length: 30

  Default Value: N

  Indicates whether the contractor is exempt for workers' compensation insurance.
• Exemptdesc: string
  Title: Exemption Reason

  Maximum Length: 500

  The description of workers' compensation exemption.
• Exemptlongdesc: string (byte)
  The long description of workers' compensation exemption.
• ExpireDate: string (date)
  Title: Expiration Date

  The expiration date of a policy or bond on a contractor license.
• InsuranceFactRec: string
  Maximum Length: 30

  The type of insurance record for the contractor data. Examples of insurance types include contractor bonds and workers' compensation.
• InsuranceType: string
  Title: Coverage Type

  Maximum Length: 360

  The type of insurance that is associated with the contractor license.
• InsurerAmt: number
  Title: Amount

  The coverage amount on a bond or insurance policy on a contractor license.
• InsurerCode: string
  Maximum Length: 30

  The code associated with an insurer on a contractor license.
• InsurerLink: string
  Maximum Length: 500

  The URL that provides access to insurer details.
• InsurerName: string
  Title: Company Name

  Maximum Length: 360

  The name of an insurer on a contractor license.
• InsurerPolicyNo: string
  Title: Policy Number

  Maximum Length: 30

  The policy number issued by an insurer on a contractor license.
• IntegrationSource: string
  Maximum Length: 30

  The external third party that validates contractor license details.
• IntentToSuspendDate: string (date)
  The date of a notice of intent to suspend policy on a contractor license.
• IntLastUpdDt: string (date)
  The date when contractor license details were last updated through integration with a third-party system.
• IssueDate: string (date)
  Title: Effective Date

  The issue date of a policy or bond on a contractor license.
• LicenseInsuranceKey: integer (int64)
  The unique identifier for a type of insurance that is associated with a contractor license.
• LicenseKey: integer (int64)
  The unique identifier for a contractor license.
• LicenseNumber: string
  Maximum Length: 50

  Default Value:

  The contractor license number issued by the government or the agency.
• LicensePercentage: integer (int32)
  The bond holder's percentage of voting stock in company.
• LicenseSetupCode: string
  Maximum Length: 30

  Default Value:

  The code identifies which data sections are used for the contractor license.
• LicenseType: string
  Maximum Length: 30

  Default Value:

  The type of the issued contractor license.
• LicQualifierName: string
  Title: Qualifier Name

  Maximum Length: 360

  The name of the qualifying bond holder.
• LicQualifierNameType: string
  Maximum Length: 20

  The type of qualifying bond holder.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RenewalDate: string (date)
  The renewal date of a policy or bond on a contractor license.
• SuspendDate: string (date)
  Title: Suspend Date

  The suspension date of a policy or bond on a contractor license.

{
    "type":"object",
    "properties":{
        "ExpireDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerLink":{
            "maxLength":"500",
            "type":"string",
            "description":"The URL that provides access to insurer details.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The contractor license number issued by the government or the agency.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "IntentToSuspendDate":{
            "type":"string",
            "description":"The date of a notice of intent to suspend policy on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InsuranceType":{
            "title":"Coverage Type",
            "maxLength":"360",
            "type":"string",
            "description":"The type of insurance that is associated with the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicensePercentage":{
            "type":"integer",
            "description":"The bond holder's percentage of voting stock in company.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "InsuranceFactRec":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of insurance record for the contractor data. Examples of insurance types include contractor bonds and workers' compensation.",
            "nullable":false,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The external third party that validates contractor license details.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdDt":{
            "type":"string",
            "description":"The date when contractor license details were last updated through integration with a third-party system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendDate":{
            "title":"Suspend Date",
            "type":"string",
            "description":"The suspension date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the issued contractor license.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "InsurerAmt":{
            "title":"Amount",
            "type":"number",
            "description":"The coverage amount on a bond or insurance policy on a contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code associated with an insurer on a contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicQualifierName":{
            "title":"Qualifier Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the qualifying bond holder.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LicQualifierNameType":{
            "maxLength":"20",
            "type":"string",
            "description":"The type of qualifying bond holder.",
            "nullable":true,
            "x-queryable":true
        },
        "Exemptlongdesc":{
            "type":"string",
            "description":"The long description of workers' compensation exemption.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "InsurerPolicyNo":{
            "title":"Policy Number",
            "maxLength":"30",
            "type":"string",
            "description":"The policy number issued by an insurer on a contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseInsuranceKey":{
            "type":"integer",
            "description":"The unique identifier for a type of insurance that is associated with a contractor license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"The issue date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "type":"string",
            "description":"The renewal date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code identifies which data sections are used for the contractor license.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "CancelDate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"The cancellation date of a policy or bond on a contractor license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Exempt":{
            "title":"Exempt",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the contractor is exempt for workers' compensation insurance.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "InsurerName":{
            "title":"Company Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of an insurer on a contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Exemptdesc":{
            "title":"Exemption Reason",
            "maxLength":"500",
            "type":"string",
            "description":"The description of workers' compensation exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"The unique identifier for a contractor license.",
            "format":"int64",
            "nullable":false,
            "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"
    }
}

Back to Top