Jump to

• Request
• Response

Get all records of contractor licenses

get

/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense

Request

Path Parameters

• LnpRecordKey(required): integer(int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • LnpLicensePuidKey: Finds a contractor license that matches the public unique identifier key criteria.
    Finder Variables:
    • LnpLicensePuid; string; The unique identifier of a contractor license that is used during the CRM import process.
  • PrimaryKey: Finds a contractor license that matches the primary key criteria.
    Finder Variables:
    • LnpLicenseKey; integer; The unique identifier of a 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:
  

  • AddedAfterSubmit; string; This indicates that a contractor license was added after the application was submitted.
  • Address1; string; The first address line on contractor???s license.
  • Address2; string; The second address line on contractor???s license.
  • Address3; string; The third address line on contractor???s license.
  • Address4; string; The fourth address line on contractor???s license.
  • AgencyId; number; The agency ID this transaction belongs to.
  • ApplicantIsAuthAgentFlag; string; This field indicates applicant is the authorized agent for a contractor license.
  • City; string; The name of the city on contractor???s license.
  • ComplaintDiscloureInd; string; This Indicates whether a complaint has been disclosed against license.
  • ContractorInUse; string; This indicates if a contractor is still in use for the application.
  • Country; string; The name of the country on contractor???s license.
  • County; string; The name of the county on contractor???s license.
  • Dba; string; The name the contractor is doing business as.
  • EmailAddress; string; The email address on contractor???s license.
  • Entity; string; The entity identified on the contractor???s license.
  • ExpireDate; string; The expiration date of contractor???s license.
  • InUseLastUpdateBy; string; The user who last updated the contractor???s In Use status.
  • InUseLastUpdateDate; string; The date when the contractor???s In Use status was last updated.
  • InactiveDate; string; Indicates the date on which the contractor???s license was inactivated.
  • IntLastUpdateBy; string; This Indicates the user who updated record with 3rd party integration data.
  • IntLastUpdateDt; string; This Indicates the date the last user updated with 3rd party integration data.
  • IntStatusLastUpdateBy; string; This Indicates the user who updated the internal license status.
  • IntStatusLastUpdateDt; string; This Indicates the date when the user updated the internal license status.
  • IntegrationSource; string; This Identifies the 3rd party integration.
  • InternalLicenseStatus; string; This is the Internally assigned status by the agent on the license.
  • IssueDate; string; The date on which the contractor???s license was issued or in effect.
  • LicenseKey; integer; The system generated number used uniquely to identify the license.
  • LicenseLmfPre; string; The suffix associated with the contractor HIS license number.
  • LicenseNumber; string; The license number issued by the government or the agency.
  • LicenseNumberTwo; string; The number portion of the contractor license.
  • LicenseSetupCode; string; This identifies the setup code that identifies the segment usages on the license.
  • LicenseSyncDate; string; This field indicates the date and time when the license was merged with the contractor license file.
  • LicenseType; string; This Identifies the type of 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; This Indicates the meaningful transaction identifier.
  • LnpRecordKey; integer; The unique identifier for the related transaction.
  • Name; string; The name on the contractor???s license.
  • Owner; string; This field indicates the owner name(s) on the contractor???s license.
  • PhoneAreaCode; string; This field indicates the phone area code on the contractor???s license.
  • PhoneCountryCode; string; This field indicates the phone country code on the contractor???s license.
  • PhoneExtension; string; This field indicates the phone extension on the contractor???s license.
  • PhoneNumber; string; This field indicates the phone number on the contractor???s license.
  • PostalCode; string; This attribute indicates the postal code on contractor???s license.
  • PostalPlus4Code; string; This attribute indicates the postal plus code on contractor???s license.
  • Province; string; This field indicates the name of province on contractor???s license.
  • ReactivateDate; string; This field indicates the reissue or renewal date of contractor???s license.
  • RecordNumber; string; The public unique identifier for the permit record that is used by the CRM Import process.
  • ReissueDate; string; This field indicates the reissue date of contractor???s license.
  • SourceStatus; string; The source status of the contractor???s license.
  • State; string; This field indicates the name of the state on contractor license.
  • SubjectId; string; The attribute used to identify where the data should be displayed.
  • SuspendDate; string; The first date of contract???s license suspension.
  • SyncType; string; Identifies whether the contractor license is new or updated.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to 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 : publicSectorPzRecords-RecordContractorLicense

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/publicSectorPzRecords-RecordContractorLicense-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPzRecords-RecordContractorLicense-item-response

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

Type: object

Show Source

• AddedAfterSubmit: string
  Maximum Length: 1

  Default Value: N

  This indicates that a contractor license was added after the application was submitted.
• Address1: string
  Title: Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

  The second address line on contractor???s license.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address line on contractor???s license.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address line on contractor???s license.
• AgencyId: number
  Default Value: 1

  The agency ID this transaction belongs to.
• ApplicantIsAuthAgentFlag: string
  Maximum Length: 1

  Default Value: N

  This field indicates applicant is the authorized agent for a contractor license.
• BusinessLicense: string
  The related business license for the specified license.
• City: string
  Title: City

  Maximum Length: 60

  The name of the city on contractor???s license.
• ComplaintDiscloureInd: string
  Maximum Length: 1

  This Indicates whether a complaint has been disclosed against license.
• Contact: string
  The contact person for the license.
• ContractorInUse: string
  Maximum Length: 1

  Default Value: Y

  This indicates if a contractor is still in use for the application.
• Country: string
  Title: Country

  Maximum Length: 60

  The name of the country on contractor???s license.
• County: string
  Title: County

  Maximum Length: 60

  The name of the county on contractor???s license.
• Dba: string
  Title: Doing Business As

  Maximum Length: 360

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

  Maximum Length: 320

  The email address on contractor???s license.
• Enabled: string
  This field indicates whether the license is valid for use.
• Entity: string
  Title: Ownership Type

  Maximum Length: 30

  The entity identified on the contractor???s license.
• ExpireDate: string (date)
  Title: Expire Date

  The expiration date of contractor???s license.
• InactiveDate: string (date)
  Indicates the date on which the contractor???s license was inactivated.
• IntegrationSource: string
  Title: Integration Name

  Maximum Length: 30

  This Identifies the 3rd party integration.
• InternalLicenseStatus: string
  Title: Status

  Maximum Length: 30

  This is the Internally assigned status by the agent on the license.
• IntLastUpdateBy: string
  Title: Last Updated By

  Maximum Length: 64

  This Indicates the user who updated record with 3rd party integration data.
• IntLastUpdateDt: string (date)
  Title: Last Updated Date

  This Indicates the date the last user updated with 3rd party integration data.
• IntStatusLastUpdateBy: string
  Title: Last Updated By

  Maximum Length: 64

  This Indicates the user who updated the internal license status.
• IntStatusLastUpdateDt: string (date)
  Title: Last Updated Date

  This Indicates the date when the user updated the internal license status.
• InUseLastUpdateBy: string
  Maximum Length: 64

  The user who last updated the contractor???s In Use status.
• InUseLastUpdateDate: string (date)
  The date when the contractor???s In Use status was last updated.
• IssueDate: string (date)
  Title: Issue Date

  The date on which the contractor???s license was issued or in effect.
• LicenseKey: integer (int64)
  Title: License Number

  The system generated number used uniquely to identify the license.
• LicenseLmfPre: string
  Maximum Length: 10

  The suffix associated with the contractor HIS license number.
• LicenseNumber: string
  Title: License Number

  Maximum Length: 50

  The license number issued by the government or the agency.
• LicenseNumberTwo: string
  Title: License Number

  Maximum Length: 50

  The number portion of the contractor license.
• LicenseSetupCode: string
  Title: License Source

  Maximum Length: 30

  This identifies the setup code that identifies the segment usages on the license.
• LicenseSyncDate: string (date-time)
  This field indicates the date and time when the license was merged with the contractor license file.
• LicenseType: string
  Maximum Length: 30

  This Identifies the type of license issued.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpLicenseKey: integer (int64)
  Title: License Number

  The system generated number used uniquely to identify the license on the transaction.
• LnpLicensePuid: string
  Maximum Length: 480

  The public unique identifier for the license, which is an alternate key used by the CRM Import process.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

  This Indicates the meaningful transaction identifier.
• LnpRecordKey: integer (int64)
  Title: Record ID

  The unique identifier for the related transaction.
• Name: string
  Title: Qualifier Name

  Maximum Length: 360

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

  Maximum Length: 360

  This field indicates the owner name(s) on the contractor???s license.
• PhoneAreaCode: string
  Title: Work Phone Country

  Maximum Length: 10

  This field indicates the phone area code on the contractor???s license.
• PhoneCountryCode: string
  Title: Work Phone Country Code

  Maximum Length: 10

  This field indicates the phone country code on the contractor???s license.
• PhoneExtension: string
  Title: Phone

  Maximum Length: 20

  This field indicates the phone extension on the contractor???s license.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  This field indicates the phone number on the contractor???s license.
• PostalCode: string
  Title: ZIP Code

  Maximum Length: 60

  This attribute indicates the postal code on contractor???s license.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 60

  This attribute indicates the postal plus code on contractor???s license.
• Province: string
  Title: Province

  Maximum Length: 60

  This field indicates the name of province on contractor???s license.
• ReactivateDate: string (date)
  This field indicates the reissue or renewal date of contractor???s license.
• RecordContractorLicFact: array Record Contractor License Facts
  Title: Record Contractor License Facts

  The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates lincense fact information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
• RecordContractorLicInsurance: array Record Contractor License Insurances
  Title: Record Contractor License Insurances

  The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates lincense Insurance information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
• RecordNumber: string
  Maximum Length: 64

  The public unique identifier for the permit record that is used by the CRM Import process.
• ReissueDate: string (date)
  Title: Reissue Date

  This field indicates the reissue date of contractor???s license.
• SourceStatus: string
  Maximum Length: 100

  The source status of the contractor???s license.
• State: string
  Title: State

  Maximum Length: 60

  This field indicates the name of the state on contractor license.
• SubjectId: string
  Maximum Length: 30

  The attribute used to identify where the data should be displayed.
• SuspendDate: string (date)
  The first date of contract???s license suspension.
• SyncType: string
  Read Only: true

  Maximum Length: 30

  Identifies whether the contractor license is new or updated.

{
    "type":"object",
    "properties":{
        "Entity":{
            "title":"Ownership Type",
            "maxLength":"30",
            "type":"string",
            "description":"The entity identified on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "Dba":{
            "title":"Doing Business As",
            "maxLength":"360",
            "type":"string",
            "description":"The name the contractor is doing business as.",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner Name",
            "maxLength":"360",
            "type":"string",
            "description":"This field indicates the owner name(s) on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "ReissueDate":{
            "title":"Reissue Date",
            "type":"string",
            "description":"This field indicates the reissue date of contractor???s license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InternalLicenseStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"This is the Internally assigned status by the agent on the license.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpireDate":{
            "title":"Expire Date",
            "type":"string",
            "description":"The expiration date of contractor???s license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseNumber":{
            "title":"License Number",
            "maxLength":"50",
            "type":"string",
            "description":"The license number issued by the government or the agency.",
            "nullable":true,
            "x-queryable":true
        },
        "InUseLastUpdateBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the contractor???s In Use status.",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "title":"Integration Name",
            "maxLength":"30",
            "type":"string",
            "description":"This Identifies the 3rd party integration.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdateDt":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"This Indicates the date the last user updated with 3rd party integration data.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Qualifier Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntStatusLastUpdateDt":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"This Indicates the date when the user updated the internal license status.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseSyncDate":{
            "type":"string",
            "description":"This field indicates the date and time when the license was merged with the contractor license file.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicantIsAuthAgentFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"This field indicates applicant is the authorized agent for a contractor license.",
            "nullable":false,
            "default":"N",
            "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,
            "x-queryable":true
        },
        "RecordContractorLicInsurance":{
            "title":"Record Contractor License Insurances",
            "type":"array",
            "description":"The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates lincense Insurance information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP<Agency ID><Record Type Code>_c.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPzRecords-RecordContractorLicense-RecordContractorLicInsurance-item-response"
            }
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractorInUse":{
            "maxLength":"1",
            "type":"string",
            "description":"This indicates if a contractor is still in use for the application.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier for the related transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseLmfPre":{
            "maxLength":"10",
            "type":"string",
            "description":"The suffix associated with the contractor HIS license number.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"This field indicates the name of province on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone",
            "maxLength":"20",
            "type":"string",
            "description":"This field indicates the phone extension on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"60",
            "type":"string",
            "description":"This attribute indicates the postal plus code on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessLicense":{
            "type":"string",
            "description":"The related business license for the specified license.",
            "nullable":true,
            "x-queryable":false
        },
        "LicenseNumberTwo":{
            "title":"License Number",
            "maxLength":"50",
            "type":"string",
            "description":"The number portion of the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "SyncType":{
            "maxLength":"30",
            "type":"string",
            "description":"Identifies whether the contractor license is new or updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"This field indicates the name of the state on contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the country on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "InUseLastUpdateDate":{
            "type":"string",
            "description":"The date when the contractor???s In Use status was last updated.",
            "format":"date",
            "nullable":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,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"number",
            "description":"The agency ID this transaction belongs to.",
            "nullable":true,
            "default":"1",
            "x-queryable":true
        },
        "LnpLicenseKey":{
            "title":"License Number",
            "type":"integer",
            "description":"The system generated number used uniquely to identify the license on the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"ZIP Code",
            "maxLength":"60",
            "type":"string",
            "description":"This attribute indicates the postal code on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendDate":{
            "type":"string",
            "description":"The first date of contract???s license suspension.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":"30",
            "type":"string",
            "description":"This Identifies the type of license issued.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Work Phone Country",
            "maxLength":"10",
            "type":"string",
            "description":"This field indicates the phone area code on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"This field indicates the phone country code on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordContractorLicFact":{
            "title":"Record Contractor License Facts",
            "type":"array",
            "description":"The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates lincense fact information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP<Agency ID><Record Type Code>_c.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPzRecords-RecordContractorLicense-RecordContractorLicFact-item-response"
            }
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplaintDiscloureInd":{
            "maxLength":"1",
            "type":"string",
            "description":"This Indicates whether a complaint has been disclosed against license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntStatusLastUpdateBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"This Indicates the user who updated the internal license status.",
            "nullable":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":false,
            "x-queryable":true
        },
        "InactiveDate":{
            "type":"string",
            "description":"Indicates the date on which the contractor???s license was inactivated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"This Indicates the meaningful transaction identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"The source status of the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third address line on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date on which the contractor???s license was issued or in effect.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Enabled":{
            "type":"string",
            "description":"This field indicates whether the license is valid for use.",
            "nullable":true,
            "x-queryable":false
        },
        "ReactivateDate":{
            "type":"string",
            "description":"This field indicates the reissue or renewal date of contractor???s license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first address line on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "Contact":{
            "type":"string",
            "description":"The contact person for the license.",
            "nullable":true,
            "x-queryable":false
        },
        "LicenseSetupCode":{
            "title":"License Source",
            "maxLength":"30",
            "type":"string",
            "description":"This identifies the setup code that identifies the segment usages on the license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdateBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"This Indicates the user who updated record with 3rd party integration data.",
            "nullable":true,
            "x-queryable":true
        },
        "AddedAfterSubmit":{
            "maxLength":"1",
            "type":"string",
            "description":"This indicates that a contractor license was added after the application was submitted.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"This field indicates the phone number on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "title":"License Number",
            "type":"integer",
            "description":"The system generated number used uniquely to identify the license.",
            "format":"int64",
            "nullable":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 : Record Contractor License Facts

Type: array

Title: Record Contractor License Facts

The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates lincense fact information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Show Source

• Array of: object publicSectorPzRecords-RecordContractorLicense-RecordContractorLicFact-item-response

{
    "title":"Record Contractor License Facts",
    "type":"array",
    "description":"The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates lincense fact information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP<Agency ID><Record Type Code>_c.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPzRecords-RecordContractorLicense-RecordContractorLicFact-item-response"
    }
}

Nested Schema : Record Contractor License Insurances

Type: array

Title: Record Contractor License Insurances

The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates lincense Insurance information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.

Show Source

• Array of: object publicSectorPzRecords-RecordContractorLicense-RecordContractorLicInsurance-item-response

{
    "title":"Record Contractor License Insurances",
    "type":"array",
    "description":"The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates lincense Insurance information associated with contractor license. Note: You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP<Agency ID><Record Type Code>_c.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPzRecords-RecordContractorLicense-RecordContractorLicInsurance-item-response"
    }
}

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 : publicSectorPzRecords-RecordContractorLicense-RecordContractorLicFact-item-response

Type: object

Show Source

• CntrctrLicFactRec: string
  Maximum Length: 30

  This Identifies the type of fact record for the data.
• IntegrationSource: string
  Title: Integration Name

  Maximum Length: 30

  This identifies 3rd party integration.
• IntLastUpdDt: string (date)
  Title: Last Updated

  The date last updated by 3rd party???s system.
• LicenseFactKey: integer (int64)
  The system generated number used uniquely to identify the license.
• LicenseKey: integer (int64)
  This field Indicates the unique identifier of the license.
• LicenseNumber: string
  Maximum Length: 50

  Default Value:

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

  Default Value:

  The setup code that identifies segments usage on the license.
• LicenseType: string
  Maximum Length: 30

  Default Value:

  The type of the license issued.
• LicFactCode: string
  Maximum Length: 30

  This identifies the code for this fact data.
• LicFactCodeValue: string
  Maximum Length: 500

  This Identifies the value for this fact data.
• LicFactDate: string (date)
  This Identifies the date for this fact data.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpLicenseFactKey: integer (int64)
  The auto generated number used uniquely to identify the license on the transaction.
• LnpLicenseFactPuid: string
  Maximum Length: 480

  The public unique identifier for the license fact, which is an alternate key used by the CRM Import process.
• LnpLicenseKey: integer (int64)
  Title: License Number

  This field Indicates the unique identifier of the license for the transaction.
• LnpLicensePuid: string
  Maximum Length: 480

  The parent unique identifier, which is an alternate key used by the CRM Import process.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

  This field Indicates the meaningful transaction identifier.
• LnpRecordKey: integer (int64)
  Title: Record ID

  The unique identifier for the related transaction.

{
    "type":"object",
    "properties":{
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"This field Indicates the meaningful transaction identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "LnpLicenseFactKey":{
            "type":"integer",
            "description":"The auto generated number used uniquely to identify the license on the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LicFactCode":{
            "maxLength":"30",
            "type":"string",
            "description":"This identifies the code for this fact data.",
            "nullable":false,
            "x-queryable":true
        },
        "LicenseNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The license number issued by the government or the agency.",
            "nullable":true,
            "default":" ",
            "x-queryable":true
        },
        "LnpLicenseKey":{
            "title":"License Number",
            "type":"integer",
            "description":"This field Indicates the unique identifier of the license for the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IntLastUpdDt":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date last updated by 3rd party???s system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "title":"Integration Name",
            "maxLength":"30",
            "type":"string",
            "description":"This identifies 3rd party integration.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier for the related transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the license issued.",
            "nullable":true,
            "default":" ",
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The setup code that identifies segments usage on the license.",
            "nullable":true,
            "default":" ",
            "x-queryable":true
        },
        "LicFactCodeValue":{
            "maxLength":"500",
            "type":"string",
            "description":"This Identifies the value for this fact data.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LnpLicenseFactPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for the license fact, which is an alternate key used by the CRM Import process.",
            "nullable":false,
            "x-queryable":true
        },
        "LicenseFactKey":{
            "type":"integer",
            "description":"The system generated number used uniquely to identify the license.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LnpLicensePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The parent unique identifier, which is an alternate key used by the CRM Import process.",
            "nullable":true,
            "x-queryable":true
        },
        "LicFactDate":{
            "type":"string",
            "description":"This Identifies the date for this fact data.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CntrctrLicFactRec":{
            "maxLength":"30",
            "type":"string",
            "description":"This Identifies the type of fact record for the data.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"This field Indicates the unique identifier of the license.",
            "format":"int64",
            "nullable":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 : publicSectorPzRecords-RecordContractorLicense-RecordContractorLicInsurance-item-response

Type: object

Show Source

• CancelDate: string (date)
  Title: Cancellation Date

  This field indicates the cancellation date of the policy or bond on the license.
• Exempt: string
  Title: Exempt

  Maximum Length: 30

  Default Value: N

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

  Maximum Length: 500

  This field indicates description of workers' compensation exemption.
• Exemptlongdesc: string (byte)
  This field indicates the long description of workers' compensation exemption.
• ExpireDate: string (date)
  Title: Expire Date

  This field indicates the expiry date of the policy or bond on the license.
• InsuranceFactRec: string
  Maximum Length: 30

  This field indicates the type of insurance associated with state license.
• InsuranceType: string
  Title: Insurance Type

  Maximum Length: 360

  This field indicates the type of insurance on license.
• InsurerAmt: number
  Title: Amount

  This field indicates the coverage amount on the bond or policy on the license.
• InsurerCode: string
  Title: Code

  Maximum Length: 30

  This field indicates the code associated with insurer on license.
• InsurerLink: string
  Maximum Length: 500

  The additional URL link to drill into insurer details.
• InsurerName: string
  Title: Company Name

  Maximum Length: 360

  This field indicates the name of insurer on contractor license.
• InsurerPolicyNo: string
  Title: Policy Number

  Maximum Length: 30

  This field indicates the policy number issued by the insurer on license.
• IntegrationSource: string
  Title: Integration Name

  Maximum Length: 30

  This field Identifies the 3rd party integration.
• IntentToSuspendDate: string (date)
  This field indicates the intent to suspend policy notice date.
• IntLastUpdDt: string (date)
  Title: Last Updated Date

  This field indicates the date last updated by the 3rd party???s system.
• IssueDate: string (date)
  Title: Issue Date

  This field indicates the issue date of the policy or bond on the license.
• LicenseInsuranceKey: integer (int64)
  The system generated number used uniquely to identify the license.
• LicenseNumber: string
  Maximum Length: 50

  The license number issued by the government or the agency.
• LicensePercentage: integer (int32)
  This field indicates the percentage of voting stock in the company.
• LicenseSetupCode: string
  Maximum Length: 30

  Default Value:

  The setup code that identifies segments usage on the license.
• LicenseType: string
  Maximum Length: 30

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

  Maximum Length: 360

  This field indicates the name of the qualifying individual on bond.
• LicQualifierNameType: string
  Maximum Length: 20

  This field indicates the type of qualifier bond on bond.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpLicenseInsKey: integer (int64)
  This field Indicates the unique identifier of the license for the transaction.
• LnpLicenseInsPuid: string
  Maximum Length: 480

  The public unique identifier for license insurance, which is an alternate key used by the CRM Import process.
• LnpLicenseKey: integer (int64)
  Title: License Number

  This field indicates the unique identifier of the license transaction.
• LnpLicensePuid: string
  Maximum Length: 480

  The parent unique identifier, which is an alternate key used by the CRM Import process.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

  This field indicates the meaningful transaction identifier.
• LnpRecordKey: integer (int64)
  Title: Record ID

  The unique identifier for the related transaction.
• RenewalDate: string (date)
  This field indicates the renewal date of the policy or bond on the license.
• SuspendDate: string (date)
  This field indicates the suspension date of the policy or bond on the license.

{
    "type":"object",
    "properties":{
        "LnpLicenseInsKey":{
            "type":"integer",
            "description":"This field Indicates the unique identifier of the license for the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExpireDate":{
            "title":"Expire Date",
            "type":"string",
            "description":"This field indicates the expiry date of the policy or bond on the license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerLink":{
            "maxLength":"500",
            "type":"string",
            "description":"The additional URL link to drill into insurer details.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The license number issued by the government or the agency.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicenseKey":{
            "title":"License Number",
            "type":"integer",
            "description":"This field indicates the unique identifier of the license transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IntentToSuspendDate":{
            "type":"string",
            "description":"This field indicates the intent to suspend policy notice date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InsuranceType":{
            "title":"Insurance Type",
            "maxLength":"360",
            "type":"string",
            "description":"This field indicates the type of insurance on license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicensePercentage":{
            "type":"integer",
            "description":"This field indicates the percentage of voting stock in the company.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "InsuranceFactRec":{
            "maxLength":"30",
            "type":"string",
            "description":"This field indicates the type of insurance associated with state license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdDt":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"This field indicates the date last updated by the 3rd party???s system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "title":"Integration Name",
            "maxLength":"30",
            "type":"string",
            "description":"This field Identifies the 3rd party integration.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicenseInsPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for license insurance, which is an alternate key used by the CRM Import process.",
            "nullable":false,
            "x-queryable":true
        },
        "SuspendDate":{
            "type":"string",
            "description":"This field indicates the suspension date of the policy or bond on the license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the license issued.",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerAmt":{
            "title":"Amount",
            "type":"number",
            "description":"This field indicates the coverage amount on the bond or policy on the license.",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"This field indicates the code associated with insurer on license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicQualifierName":{
            "title":"Qualifier Name",
            "maxLength":"360",
            "type":"string",
            "description":"This field indicates the name of the qualifying individual on bond.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LnpLicensePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The parent unique identifier, which is an alternate key used by the CRM Import process.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"This field indicates the meaningful transaction identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "Exemptlongdesc":{
            "type":"string",
            "description":"This field indicates the long description of workers' compensation exemption.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LicQualifierNameType":{
            "maxLength":"20",
            "type":"string",
            "description":"This field indicates the type of qualifier bond on bond.",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerPolicyNo":{
            "title":"Policy Number",
            "maxLength":"30",
            "type":"string",
            "description":"This field indicates the policy number issued by the insurer on license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseInsuranceKey":{
            "type":"integer",
            "description":"The system generated number used uniquely to identify the license.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"This field indicates the issue date of the policy or bond on the license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record ID",
            "type":"integer",
            "description":"The unique identifier for the related transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RenewalDate":{
            "type":"string",
            "description":"This field indicates the renewal date of the policy or bond on the license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The setup code that identifies segments usage on the license.",
            "nullable":true,
            "default":" ",
            "x-queryable":true
        },
        "CancelDate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"This field indicates the cancellation date of the policy or bond on the 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":"This field indicates the name of insurer on contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Exemptdesc":{
            "title":"Exemption Reason",
            "maxLength":"500",
            "type":"string",
            "description":"This field indicates description of workers' compensation exemption.",
            "nullable":true,
            "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