Jump to

• Request
• Response

Get all records of authorized agents

get

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

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:
  
  

  • LnpAuthorizedAgntPuidKey: Finds an authorized agent that matches the public unique identifier key criteria.
    Finder Variables:
    • LnpAuthorizedAgntPuid; string; The unique identifier of an authorized agent that is used during the CRM import process.
  • PrimaryKey: Finds a authorized agent that matches the primary key criteria.
    Finder Variables:
    • LnpAuthorizedAgntKey; integer; The unique identifier of an authorized agent.
• 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; This field indicates first address line of contact address.
  • Address2; string; This field indicates second address line of contact address.
  • Address3; string; This field indicates third address line of contact address.
  • Address4; string; This field indicates fourth address line of contact address.
  • AgentAddressId; integer; The reference key to the TCA location table.
  • AgentSource; string; The source of the agent.
  • ApplicantIsAuthAgentFlag; string; Indicates applicant is the authorized agent.
  • AssociateDate; string; The date associated with the Contractor License.
  • AuthorizeStatus; string; The status of the agent associated with the contractor license.
  • BePersonId; string; This field indicates the identifier of a responsible person for the business.
  • BePersonKey; integer; This field indicates the unique identifier of a responsible person for the business.
  • BusinessEntityId; string; The meaningful identifier for the business location.
  • BusinessEntityKey; integer; The unique identifier for the business entity.
  • BusinessLocationId; string; The identifier for the business location.
  • BusinessLocationKey; integer; The unique identifier for the business location.
  • City; string; The name of city for the contact address.
  • ContactBizPartyId; integer; This field indicates party ID associated with the applicant.
  • ContactBizProfileId; integer; This field indicates business profile ID associated with the applicant.
  • ContactDmvLicExp; string; The responsible person???s driver???s license expiration date.
  • ContactDmvLicNum; string; The responsible person???s driver???s license number.
  • ContactDmvLicSt; string; The responsible person???s driver???s license issued state.
  • ContactId; integer; This field indicates contact ID associated with the applicant.
  • ContactPartyId; integer; This field indicates party ID associated with the applicant.
  • ContactProfileId; integer; This field indicates profile ID associated with the applicant.
  • ContactType; string; This field Identifies the type of contact the person is associated with the license.
  • Country; string; This field indicates the name of the country for the contact address.
  • County; string; This field indicates the name of the county for the contact address.
  • CreationDate; string; This attribute indicates the date and time of the creation of the row.
  • DateOfBirth; string; The responsible person???s date of birth.
  • DisassociateDate; string; This field indicates the disassociated date from the Contractor License.
  • EmailAddress; string; This field indicates the email address of the person associated with the contractor license.
  • EmergContactPhone; string; The person???s emergency contact phone number.
  • EmergencyContactFlag; boolean; Indicates if an emergency contact phone exists.
  • JobTitle; string; This field identifies the person???s job title associated with the contact.
  • LastUpdateDate; string; The user who last updated the record.
  • LnpAuthorizedAgntKey; integer; The system generated number used uniquely to identify the license.
  • LnpAuthorizedAgntPuid; string; The public unique identifier for authorized agent, which is an alternate key used by the CRM Import process.
  • LnpLicenseKey; integer; The system generated number used uniquely to identify the license on the transaction.
  • LnpRecordId; string; This field indicates the meaningful transaction identifier.
  • LnpRecordKey; integer; This field indicates the unique identifier of the license.
  • ObjectVersionNumber; integer; The system attribute that captures the incremental version number for an object.
  • OrganizationName; string; The organization of person associated with the contractor license.
  • PartyId; integer; This field indicates the party ID associated with the applicant.
  • PersonFirstName; string; This field indicates the first name of person associated with the contractor license.
  • PersonLastName; string; This field indicates the last name of person associated with the contractor license.
  • PersonLengthAtAddress; integer; The length of time the person has been at the address.
  • PersonMiddleName; string; This field indicates the middle name of person associated with the contractor license.
  • PersonName; string; This field indicates the full concatenated name including first, middle, last, and suffix names.
  • PersonNameSuffix; string; This field indicates the suffix associated with the person name.
  • PersonPreNameAdjunct; string; The salutation for the responsible person.
  • PhoneAreaCode; string; This field indicates the area code of the phone number associated with contact.
  • PhoneCountryCode; string; This field indicates the phone country code associated with phone number.
  • PhoneExtension; string; This field indicates phone extension associated with the phone number.
  • PhoneNumber; string; The phone number of the authorized agent.
  • PhoneType; string; The type of phone for the responsible person.
  • PostalCode; string; This field indicates the postal code for the contact address.
  • PostalPlus4Code; string; The extended postal code of the agent.
  • PrimaryFlag; boolean; This field identifies the preferred contact for the contractor.
  • Province; string; This field indicates the name of the province for the contact address.
  • RawPhoneNumber; string; The responsible person???s full phone number.
  • RecordNumber; string; The public unique identifier for the permit record that is used by the CRM Import process.
  • SourceAgentKey; integer; The system generated number used uniquely to identify the agent.
  • SourceKey; integer; This field Indicates the unique identifier of the source transaction.
  • State; string; This field indicates the name of state for the contact address.
  • Status; string; The status of the responsible person for the business.
  • SubjectId; string; The attribute used to identify where the data should be displayed.
  • VerificationDate; string; The date the responsible person was verified.
  • VerificationStatus; string; The verification status for the responsible person.
  • VerifiedBy; string; The agency staff that verified the responsible person.
• 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-RecordAuthorizedAgent

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-RecordAuthorizedAgent-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

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

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  This field indicates first address line of contact address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  This field indicates second address line of contact address.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  This field indicates third address line of contact address.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  This field indicates fourth address line of contact address.
• AgentAddressId: integer (int64)
  The reference key to the TCA location table.
• AgentSource: string
  Maximum Length: 30

  The source of the agent.
• ApplicantIsAuthAgentFlag: string
  Title: Is the applicant an authorized agent?

  Maximum Length: 1

  Indicates applicant is the authorized agent.
• AssociateDate: string (date)
  The date associated with the Contractor License.
• AuthorizeStatus: string
  Title: Verification Status

  Maximum Length: 30

  The status of the agent associated with the contractor license.
• BePersonId: string
  Maximum Length: 200

  This field indicates the identifier of a responsible person for the business.
• BePersonKey: integer (int64)
  This field indicates the unique identifier of a responsible person for the business.
• BusinessEntityId: string
  Maximum Length: 50

  The meaningful identifier for the business location.
• BusinessEntityKey: integer (int64)
  The unique identifier for the business entity.
• BusinessLocationId: string
  Maximum Length: 50

  The identifier for the business location.
• BusinessLocationKey: integer (int64)
  The unique identifier for the business location.
• City: string
  Title: City

  Maximum Length: 60

  The name of city for the contact address.
• ContactBizPartyId: integer (int64)
  Title: Business Party

  This field indicates party ID associated with the applicant.
• ContactBizProfileId: integer (int64)
  Title: Business Profile

  This field indicates business profile ID associated with the applicant.
• ContactDmvLicExp: string (date)
  The responsible person???s driver???s license expiration date.
• ContactDmvLicNum: string
  Maximum Length: 30

  The responsible person???s driver???s license number.
• ContactDmvLicSt: string
  Maximum Length: 60

  The responsible person???s driver???s license issued state.
• ContactId: integer (int64)
  Title: Contact Key

  This field indicates contact ID associated with the applicant.
• ContactPartyId: integer (int64)
  Title: Contact Party

  This field indicates party ID associated with the applicant.
• ContactProfileId: integer (int64)
  Title: Applicant Profile

  This field indicates profile ID associated with the applicant.
• ContactType: string
  Title: Contact Type

  Maximum Length: 30

  This field Identifies the type of contact the person is associated with the license.
• Country: string
  Title: Country

  Maximum Length: 60

  This field indicates the name of the country for the contact address.
• County: string
  Title: County

  Maximum Length: 60

  This field indicates the name of the county for the contact address.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  This attribute indicates the date and time of the creation of the row.
• DateOfBirth: string (date)
  The responsible person???s date of birth.
• DisassociateDate: string (date)
  This field indicates the disassociated date from the Contractor License.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  This field indicates the email address of the person associated with the contractor license.
• EmergContactPhone: string
  Maximum Length: 60

  The person???s emergency contact phone number.
• EmergencyContactFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates if an emergency contact phone exists.
• JobTitle: string
  Title: Title

  Maximum Length: 60

  This field identifies the person???s job title associated with the contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpAuthorizedAgntKey: integer (int64)
  The system generated number used uniquely to identify the license.
• LnpAuthorizedAgntPuid: string
  Maximum Length: 480

  The public unique identifier for authorized agent, which is an alternate key used by the CRM Import process.
• LnpLicenseKey: integer (int64)
  The system generated number used uniquely to identify the license on the transaction.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

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

  This field indicates the unique identifier of the license.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  Read Only: true

  The system attribute that captures the incremental version number for an object.
• OrganizationName: string
  Title: Company Name

  Maximum Length: 360

  The organization of person associated with the contractor license.
• PartyId: integer (int64)
  This field indicates the party ID associated with the applicant.
• PersonFirstName: string
  Title: First Name

  Maximum Length: 150

  This field indicates the first name of person associated with the contractor license.
• PersonLastName: string
  Title: Last Name

  Maximum Length: 150

  This field indicates the last name of person associated with the contractor license.
• PersonLengthAtAddress: integer (int64)
  The length of time the person has been at the address.
• PersonMiddleName: string
  Title: Middle Name

  Maximum Length: 60

  This field indicates the middle name of person associated with the contractor license.
• PersonName: string
  Title: Full Name

  Maximum Length: 450

  This field indicates the full concatenated name including first, middle, last, and suffix names.
• PersonNameSuffix: string
  Title: Suffix

  Maximum Length: 30

  This field indicates the suffix associated with the person name.
• PersonPreNameAdjunct: string
  Title: Salutation

  Maximum Length: 30

  The salutation for the responsible person.
• PhoneAreaCode: string
  Title: Work Phone Country Code

  Maximum Length: 10

  This field indicates the area code of the phone number associated with contact.
• PhoneCountryCode: string
  Title: Work Phone Country Code

  Maximum Length: 10

  This field indicates the phone country code associated with phone number.
• PhoneExtension: string
  Title: Phone

  Maximum Length: 40

  This field indicates phone extension associated with the phone number.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 40

  The phone number of the authorized agent.
• PhoneType: string
  Maximum Length: 30

  The type of phone for the responsible person.
• PostalCode: string
  Title: ZIP Code

  Maximum Length: 60

  This field indicates the postal code for the contact address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 60

  The extended postal code of the agent.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  This field identifies the preferred contact for the contractor.
• Province: string
  Title: Province

  Maximum Length: 60

  This field indicates the name of the province for the contact address.
• RawPhoneNumber: string
  Maximum Length: 60

  The responsible person???s full phone number.
• RecordNumber: string
  Maximum Length: 64

  The public unique identifier for the permit record that is used by the CRM Import process.
• SourceAgentKey: integer (int64)
  The system generated number used uniquely to identify the agent.
• SourceKey: integer (int64)
  This field Indicates the unique identifier of the source transaction.
• State: string
  Title: State

  Maximum Length: 60

  This field indicates the name of state for the contact address.
• Status: string
  Maximum Length: 30

  The status of the responsible person for the business.
• SubjectId: string
  Maximum Length: 30

  The attribute used to identify where the data should be displayed.
• VerificationDate: string (date)
  The date the responsible person was verified.
• VerificationStatus: string
  Title: Verification Status

  Maximum Length: 30

  The verification status for the responsible person.
• VerifiedBy: string
  Maximum Length: 200

  The agency staff that verified the responsible person.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"This attribute indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The verification status for the responsible person.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationDate":{
            "type":"string",
            "description":"The date the responsible person was verified.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ContactType":{
            "title":"Contact Type",
            "maxLength":"30",
            "type":"string",
            "description":"This field Identifies the type of contact the person is associated with the license.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"This field indicates the middle name of person associated with the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactProfileId":{
            "title":"Applicant Profile",
            "type":"integer",
            "description":"This field indicates profile ID associated with the applicant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceKey":{
            "type":"integer",
            "description":"This field Indicates the unique identifier of the source transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactBizPartyId":{
            "title":"Business Party",
            "type":"integer",
            "description":"This field indicates party ID associated with the applicant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"The unique identifier for the business entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicantIsAuthAgentFlag":{
            "title":"Is the applicant an authorized agent?",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates applicant is the authorized agent.",
            "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 associated with the Contractor License.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EmergencyContactFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an emergency contact phone exists.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact Party",
            "type":"integer",
            "description":"This field indicates party ID associated with the applicant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BePersonKey":{
            "type":"integer",
            "description":"This field indicates the unique identifier of a responsible person for the business.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactDmvLicSt":{
            "maxLength":"60",
            "type":"string",
            "description":"The responsible person???s driver???s license issued state.",
            "nullable":true,
            "x-queryable":true
        },
        "SubjectId":{
            "maxLength":"30",
            "type":"string",
            "description":"The attribute used to identify where the data should be displayed.",
            "nullable":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "type":"string",
            "description":"The responsible person???s date of birth.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"The status of the responsible person for the business.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"This field indicates the last name of person associated with the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactBizProfileId":{
            "title":"Business Profile",
            "type":"integer",
            "description":"This field indicates business profile ID associated with the applicant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisassociateDate":{
            "type":"string",
            "description":"This field indicates the disassociated date from the Contractor License.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of city for the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"This field indicates the first name of person associated with the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record ID",
            "type":"integer",
            "description":"This field indicates the unique identifier of the license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"This field indicates the email address of the person associated with the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"This field indicates the name of the province for the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"This field indicates phone extension associated with the phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"60",
            "type":"string",
            "description":"The extended postal code of the agent.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessLocationId":{
            "maxLength":"50",
            "type":"string",
            "description":"The identifier for the business location.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of phone for the responsible person.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"This field indicates the name of state for the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"This field indicates the name of the country for the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "VerifiedBy":{
            "maxLength":"200",
            "type":"string",
            "description":"The agency staff that verified the responsible person.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLengthAtAddress":{
            "type":"integer",
            "description":"The length of time the person has been at the address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"20"
            },
            "x-queryable":true
        },
        "ContactDmvLicNum":{
            "maxLength":"30",
            "type":"string",
            "description":"The responsible person???s driver???s license number.",
            "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
        },
        "RawPhoneNumber":{
            "maxLength":"60",
            "type":"string",
            "description":"The responsible person???s full phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Company Name",
            "maxLength":"360",
            "type":"string",
            "description":"The organization of person associated with the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":"50",
            "type":"string",
            "description":"The meaningful identifier for the business location.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"This field identifies the preferred contact for the contractor.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicenseKey":{
            "type":"integer",
            "description":"The system generated number used uniquely to identify the license on the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgentSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The source of the agent.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"This field indicates the suffix associated with the person name.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"ZIP Code",
            "maxLength":"60",
            "type":"string",
            "description":"This field indicates the postal code for the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact Key",
            "type":"integer",
            "description":"This field indicates contact ID associated with the applicant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"This field indicates the name of the county for the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"This field identifies the person???s job title associated with the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"This field indicates the area code of the phone number associated with contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"This field indicates the phone country code associated with phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpAuthorizedAgntPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for authorized agent, which is an alternate key used by the CRM Import process.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactDmvLicExp":{
            "type":"string",
            "description":"The responsible person???s driver???s license expiration date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The system attribute that captures the incremental version number for an object.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"This field indicates fourth address line of contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpAuthorizedAgntKey":{
            "type":"integer",
            "description":"The system generated number used uniquely to identify the license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BePersonId":{
            "maxLength":"200",
            "type":"string",
            "description":"This field indicates the identifier of a responsible person for the business.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonPreNameAdjunct":{
            "title":"Salutation",
            "maxLength":"30",
            "type":"string",
            "description":"The salutation for the responsible person.",
            "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
        },
        "PersonName":{
            "title":"Full Name",
            "maxLength":"450",
            "type":"string",
            "description":"This field indicates the full concatenated name including first, middle, last, and suffix names.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceAgentKey":{
            "type":"integer",
            "description":"The system generated number used uniquely to identify the agent.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"This field indicates second address line of contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessLocationKey":{
            "type":"integer",
            "description":"The unique identifier for the business location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"This field indicates third address line of contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"This field indicates first address line of contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "EmergContactPhone":{
            "maxLength":"60",
            "type":"string",
            "description":"The person???s emergency contact phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"This field indicates the party ID associated with the applicant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgentAddressId":{
            "type":"integer",
            "description":"The reference key to the TCA location table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number of the authorized agent.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AuthorizeStatus":{
            "title":"Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the agent associated with the contractor license.",
            "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"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top