Jump to

• Request
• Response

Get all contractor fact history rows

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordContractorHistories

Request

Query Parameters

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

  • PrimaryKey: Finds the contractor history that matches the primary key specified.
    Finder Variables:
    • LnpLicenseHistKey; integer; The unique identifier of a contractor history.
  • simpleSearchFinder: Finds the contractor history that matches smart search finder.
    Finder Variables:
    • value; string; Finds the contractor history that matches smart search finder specified.
• 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; First address line on the contractor???s license.
  • Address2; string; Second address line on the contractor???s license.
  • Address3; string; Third address line on the contractor???s license.
  • Address4; string; Fourth address line on the contractor???s license.
  • AgencyId; integer; Identifies the agency ID this transaction belongs to.
  • ApplicantIsAuthAgentFlag; string; Indicates whether the applicant is the authorized agent for a contractor license.
  • ApplicationStatus; string; Indicates the application status.
  • City; string; Name of the city on the contractor???s license.
  • ComplaintDiscloureInd; string; Indicates whether a complaint has been disclosed against the license.
  • ContractorInUse; string; Indicates whether a contractor is used for the application.
  • ContractorLicenseNumber; string; The number portion of the contractor license.
  • Country; string; Name of the country on the contractor???s license.
  • County; string; Name of the county on the contractor???s license.
  • CreationDate; string; Indicates the date and time of the creation of the row.
  • Dba; string; Name the contractor is doing business as.
  • EmailAddress; string; Email address on the contractor???s license.
  • ExpireDate; string; Expiration date of the contractor???s license.
  • InUseLastUpdateBy; string; Indicates the user who last updated the contractors In Use status.
  • InUseLastUpdateDate; string; The date when the contractor's In Use status was last updated.
  • InactiveDate; string; The date when the contractor???s license was inactivated.
  • IntLastUpdateBy; string; The user who updated the record with 3rd party integration data.
  • IntLastUpdateDt; string; The date when the last user updated with 3rd party integration data.
  • IntStatusLastUpdateBy; string; The user who updated the internal license status.
  • IntStatusLastUpdateDt; string; The date when the user updated the internal license status.
  • IntegrationSource; string; Identifies the 3rd party integration.
  • InternalLicenseStatus; string; Internally assigned status by the agent on the license.
  • IssueDate; string; The date when the contractor???s license was issued or in effect.
  • LicenseEntity; string; Entity identified on the contractor???s license.
  • LicenseKey; integer; Auto generated unique number used to identify the license.
  • LicenseLmfPre; string; Suffix associated with the contractor HIS license number.
  • LicenseNumber; string; The license number issued by the government.
  • LicenseSetupCode; string; Setup code identifying segments usage on the license.
  • LicenseType; string; Identifies the type of license issued.
  • LnpLicenseHistKey; integer; Unique auto generated number used to identify the license insurance transaction history.
  • LnpLicenseKey; integer; Auto generated unique number used to identify the license on the transaction.
  • LnpLicensePuid; string; Indicates In-flight or Historical transaction for data migration.
  • LnpRecordId; string; Indicates the meaningful transaction identifier.
  • LnpRecordKey; integer; Unique identifier for the related transaction.
  • MigratedDataFlag; string; Indicates the In-flight or Historical transaction for data migration.
  • Name; string; Name on the contractor???s license.
  • Owner; string; Owner name(s) on the contractor???s license.
  • PhoneAreaCode; string; Phone Area Code on the contractor???s license.
  • PhoneCountryCode; string; Phone country code on the contractor???s license.
  • PhoneExtension; string; Phone extension on the contractor???s license.
  • PhoneNumber; string; Phone number on the contractor???s license.
  • PostalCode; string; Postal code on contractor???s license.
  • Province; string; Name of province on contractor???s license.
  • ReactivateDate; string; Reissue or renewal date of contractor???s license.
  • RecordNumber; string; PUID for permit record. Used by CRM Import.
  • ReissueDate; string; Reissue date of contractor???s license.
  • SourceStatus; string; License status as listed in the source.
  • State; string; Name of State on contractor???s license.
  • SuspendDate; string; First date of contract???s license suspension.
• 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: string
  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: string
  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 : publicSectorRecordContractorHistories

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorRecordContractorHistories-item-response

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

Type: object

Show Source

• Address1: string
  Maximum Length: 240

  First address line on the contractor???s license.
• Address2: string
  Maximum Length: 240

  Second address line on the contractor???s license.
• Address3: string
  Maximum Length: 240

  Third address line on the contractor???s license.
• Address4: string
  Maximum Length: 240

  Fourth address line on the contractor???s license.
• AgencyId: integer (int32)
  Default Value: 1

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

  Default Value: N

  Indicates whether the applicant is the authorized agent for a contractor license.
• ApplicationStatus: string
  Maximum Length: 15

  Indicates the application status.
• City: string
  Maximum Length: 60

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

  Indicates whether a complaint has been disclosed against the license.
• ContractorInUse: string
  Maximum Length: 1

  Default Value: Y

  Indicates whether a contractor is used for the application.
• ContractorLicenseNumber: string
  Maximum Length: 50

  The number portion of the contractor license.
• Country: string
  Maximum Length: 60

  Name of the country on the contractor???s license.
• County: string
  Maximum Length: 60

  Name of the county on the contractor???s license.
• CreationDate: string (date-time)
  Read Only: true

  Indicates the date and time of the creation of the row.
• Dba: string
  Maximum Length: 360

  Name the contractor is doing business as.
• EmailAddress: string
  Maximum Length: 320

  Email address on the contractor???s license.
• ExpireDate: string (date)
  Expiration date of the contractor???s license.
• InactiveDate: string (date)
  The date when the contractor???s license was inactivated.
• IntegrationSource: string
  Maximum Length: 30

  Identifies the 3rd party integration.
• InternalLicenseStatus: string
  Maximum Length: 30

  Internally assigned status by the agent on the license.
• IntLastUpdateBy: string
  Maximum Length: 64

  The user who updated the record with 3rd party integration data.
• IntLastUpdateDt: string (date)
  The date when the last user updated with 3rd party integration data.
• IntStatusLastUpdateBy: string
  Maximum Length: 64

  The user who updated the internal license status.
• IntStatusLastUpdateDt: string (date)
  The date when the user updated the internal license status.
• InUseLastUpdateBy: string
  Maximum Length: 64

  Indicates the user who last updated the contractors In Use status.
• InUseLastUpdateDate: string (date)
  The date when the contractor's In Use status was last updated.
• IssueDate: string (date)
  The date when the contractor???s license was issued or in effect.
• LicenseEntity: string
  Maximum Length: 30

  Entity identified on the contractor???s license.
• LicenseKey: integer (int64)
  Auto generated unique number used to identify the license.
• LicenseLmfPre: string
  Maximum Length: 10

  Suffix associated with the contractor HIS license number.
• LicenseNumber: string
  Maximum Length: 50

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

  Setup code identifying segments usage on the license.
• LicenseType: string
  Maximum Length: 30

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

  The link relations associated with the resource instance.
• LnpLicenseHistKey: integer (int64)
  Unique auto generated number used to identify the license insurance transaction history.
• LnpLicenseKey: integer (int64)
  Auto generated unique number used to identify the license on the transaction.
• LnpLicensePuid: string
  Maximum Length: 480

  Indicates In-flight or Historical transaction for data migration.
• LnpRecordId: string
  Maximum Length: 50

  Indicates the meaningful transaction identifier.
• LnpRecordKey: integer (int64)
  Unique identifier for the related transaction.
• MigratedDataFlag: string
  Maximum Length: 3

  Default Value: N

  Indicates the In-flight or Historical transaction for data migration.
• Name: string
  Maximum Length: 360

  Name on the contractor???s license.
• Owner: string
  Maximum Length: 360

  Owner name(s) on the contractor???s license.
• PhoneAreaCode: string
  Maximum Length: 10

  Phone Area Code on the contractor???s license.
• PhoneCountryCode: string
  Maximum Length: 10

  Phone country code on the contractor???s license.
• PhoneExtension: string
  Maximum Length: 20

  Phone extension on the contractor???s license.
• PhoneNumber: string
  Maximum Length: 40

  Phone number on the contractor???s license.
• PostalCode: string
  Maximum Length: 60

  Postal code on contractor???s license.
• Province: string
  Maximum Length: 60

  Name of province on contractor???s license.
• ReactivateDate: string (date)
  Reissue or renewal date of contractor???s license.
• RecordContractorFactHistories: array Fact Histories
  Title: Fact Histories

  The fact histories resource is used to view, or create a contractor fact history.
• RecordContractorInsuranceHistories: array Insurance Histories
  Title: Insurance Histories

  The insurance histories resource is used to view, or create a contractor insurance history.
• RecordNumber: string
  Maximum Length: 64

  PUID for permit record. Used by CRM Import.
• ReissueDate: string (date)
  Reissue date of contractor???s license.
• SourceStatus: string
  Maximum Length: 100

  License status as listed in the source.
• State: string
  Maximum Length: 60

  Name of State on contractor???s license.
• SuspendDate: string (date)
  First date of contract???s license suspension.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates the In-flight or Historical transaction for data migration.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Dba":{
            "maxLength":360,
            "type":"string",
            "description":"Name the contractor is doing business as.",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "maxLength":360,
            "type":"string",
            "description":"Owner name(s) on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "ReissueDate":{
            "type":"string",
            "description":"Reissue date of contractor???s license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InternalLicenseStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Internally assigned status by the agent on the license.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpireDate":{
            "type":"string",
            "description":"Expiration date of the contractor???s license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The license number issued by the government.",
            "nullable":true,
            "x-queryable":true
        },
        "InUseLastUpdateBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the contractors In Use status.",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the 3rd party integration.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdateDt":{
            "type":"string",
            "description":"The date when the last user updated with 3rd party integration data.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":360,
            "type":"string",
            "description":"Name on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntStatusLastUpdateDt":{
            "type":"string",
            "description":"The date when the user updated the internal license status.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicantIsAuthAgentFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the 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"
            }
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the city on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractorInUse":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a contractor is used for the application.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"Unique identifier for the related transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"Email address on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseLmfPre":{
            "maxLength":10,
            "type":"string",
            "description":"Suffix associated with the contractor HIS license number.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"Name of province on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Phone extension on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"Name of State on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the country on the 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
        },
        "LnpLicenseHistKey":{
            "type":"integer",
            "description":"Unique auto generated number used  to identify the license insurance transaction history.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"PUID for permit record.  Used by CRM Import.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Identifies the agency ID this transaction belongs to.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "RecordContractorFactHistories":{
            "title":"Fact Histories",
            "type":"array",
            "description":"The fact histories resource is used to view, or create a contractor fact history.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordContractorHistories-RecordContractorFactHistories-item-response"
            }
        },
        "LnpLicenseKey":{
            "type":"integer",
            "description":"Auto generated unique number used to identify the license on the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Postal code on contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the county on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendDate":{
            "type":"string",
            "description":"First date of contract???s license suspension.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of license issued.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"Phone Area Code on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Phone country code on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth address line on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplaintDiscloureInd":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a complaint has been disclosed against the license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntStatusLastUpdateBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the internal license status.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicensePuid":{
            "maxLength":480,
            "type":"string",
            "description":"Indicates In-flight or Historical transaction for data migration.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordContractorInsuranceHistories":{
            "title":"Insurance Histories",
            "type":"array",
            "description":"The insurance histories resource is used to view, or create a contractor insurance history.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordContractorHistories-RecordContractorInsuranceHistories-item-response"
            }
        },
        "InactiveDate":{
            "type":"string",
            "description":"The date when the contractor???s license was inactivated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the meaningful transaction identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceStatus":{
            "maxLength":100,
            "type":"string",
            "description":"License status as listed in the source.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"Second address line on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"Third address line on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"The date when the contractor???s license was issued or in effect.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReactivateDate":{
            "type":"string",
            "description":"Reissue or renewal date of contractor???s license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"First address line on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseEntity":{
            "maxLength":30,
            "type":"string",
            "description":"Entity identified on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"Setup code identifying segments usage on the license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdateBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the record with 3rd party integration data.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationStatus":{
            "maxLength":15,
            "type":"string",
            "description":"Indicates the application status.",
            "nullable":false,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Phone number on the contractor???s license.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractorLicenseNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The number portion of the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"Auto generated unique number used 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 : Fact Histories

Type: array

Title: Fact Histories

The fact histories resource is used to view, or create a contractor fact history.

Show Source

• Array of: object publicSectorRecordContractorHistories-RecordContractorFactHistories-item-response

{
    "title":"Fact Histories",
    "type":"array",
    "description":"The fact histories resource is used to view, or create a contractor fact history.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordContractorHistories-RecordContractorFactHistories-item-response"
    }
}

Nested Schema : Insurance Histories

Type: array

Title: Insurance Histories

The insurance histories resource is used to view, or create a contractor insurance history.

Show Source

• Array of: object publicSectorRecordContractorHistories-RecordContractorInsuranceHistories-item-response

{
    "title":"Insurance Histories",
    "type":"array",
    "description":"The insurance histories resource is used to view, or create a contractor insurance history.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordContractorHistories-RecordContractorInsuranceHistories-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 : publicSectorRecordContractorHistories-RecordContractorFactHistories-item-response

Type: object

Show Source

• CntrctrLicFactRec: string
  Maximum Length: 30

  Identifies the type of fact record for the data.
• IntegrationSource: string
  Maximum Length: 30

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

  Identifies the type of license issued.
• LicenseSetupCode: string
  Maximum Length: 30

  Setup code identifying segments usages on the license.
• LicenseType: string
  Maximum Length: 30

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

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

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

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

  PUID for record. Alternate key used by CRM Import.
• LnpLicenseHistKey: integer (int64)
  Auto generated number used uniquely to identify the license transaction history.
• LnpLicenseKey: integer (int64)
  Indicates unique identifier of the license transaction.
• LnpLicensePuid: string
  Maximum Length: 480

  Parent PUID. Alternate key used by CRM Import.
• LnpRecordId: string
  Maximum Length: 50

  Indicates the meaningful transaction identifier.
• LnpRecordKey: integer (int64)
  Unique identifier for the related transaction.
• MigratedDataFlag: string
  Maximum Length: 3

  Default Value: N

  Indicates In-flight or Historical transaction for data migration.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates In-flight or Historical transaction for data migration.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the meaningful transaction identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "LicFactCode":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the code for this fact data.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicenseFactKey":{
            "type":"integer",
            "description":"Auto generated number used uniquely to identify the license on the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LicenseNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Identifies the type of license issued.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicenseKey":{
            "type":"integer",
            "description":"Indicates unique identifier of the license transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntLastUpdDt":{
            "type":"string",
            "description":"Date last updated by 3rd party???s system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies 3rd party integration.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"Unique identifier for the related transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of license issued.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"Setup code identifying segments usages on the license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicFactCodeValue":{
            "maxLength":500,
            "type":"string",
            "description":"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"
            }
        },
        "LnpLicenseFactHistKey":{
            "type":"integer",
            "description":"Auto generated number used uniquely to identify the license transaction history.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LicenseFactKey":{
            "type":"integer",
            "description":"Auto generated number used uniquely to identify the license.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LnpLicenseFactPuid":{
            "maxLength":480,
            "type":"string",
            "description":"PUID for record.  Alternate key used by CRM Import.",
            "nullable":false,
            "x-queryable":true
        },
        "LicFactDate":{
            "type":"string",
            "description":"Identifies the date for this fact data.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicensePuid":{
            "maxLength":480,
            "type":"string",
            "description":"Parent PUID.  Alternate key used by CRM Import.",
            "nullable":false,
            "x-queryable":true
        },
        "CntrctrLicFactRec":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of fact record for the data.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicenseHistKey":{
            "type":"integer",
            "description":"Auto generated number used uniquely to identify the license transaction history.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"Indicates 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 : publicSectorRecordContractorHistories-RecordContractorInsuranceHistories-item-response

Type: object

Show Source

• CancelDate: string (date)
  Cancellation date of Policy or Bond on the license.
• Exempt: string
  Maximum Length: 30

  Indicates whether the contractor is exempt for workers compensation insurance.
• Exemptdesc: string
  Maximum Length: 500

  Description of worker???s compensation exemption.
• Exemptlongdesc: string (byte)
  Long description of worker???s compensation exemption.
• ExpireDate: string (date)
  Expiry date of Policy or Bond on the license.
• InsuranceFactRec: string
  Maximum Length: 30

  Indicates the type of insurance associated with state license.
• InsuranceType: string
  Maximum Length: 360

  Type of insurance on license.
• InsurerAmt: integer (int64)
  Coverage amount on bond or policy on the license.
• InsurerCode: string
  Maximum Length: 30

  Code associated with insurer on license.
• InsurerLink: string
  Maximum Length: 500

  Additional URL link to drill into insurer details.
• InsurerName: string
  Maximum Length: 360

  Name of the insurer on the contractor license.
• InsurerPolicyNo: string
  Maximum Length: 30

  Policy number issued by insurer on the license.
• IntegrationSource: string
  Maximum Length: 30

  Identifies the 3rd party integration.
• IntentToSuspendDate: string (date)
  Intent to suspend policy notice date.
• IntLastUpdDt: string (date)
  The date last updated by 3rd party system.
• IssueDate: string (date)
  Issue date of Policy or Bond on the license.
• LicenseInsuranceKey: integer (int64)
  Auto generated unique number used to identify the license.
• LicenseKey: integer (int64)
  The unique identifier of the license.
• LicenseNumber: string
  Maximum Length: 50

  The license number issued by the government.
• LicensePercentage: integer (int32)
  Percentage of voting stock in company.
• LicenseSetupCode: string
  Maximum Length: 30

  Setup code identifying segments usages on the license.
• LicenseType: string
  Maximum Length: 30

  The type of license issued.
• LicQualifierName: string
  Maximum Length: 360

  Name of qualifying individual on the bond.
• LicQualifierNameType: string
  Maximum Length: 20

  Type of qualifier bond on the bond.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpLicenseHistKey: integer (int64)
  Auto generated number used uniquely to identify the license transaction history.
• LnpLicenseInsHistKey: integer (int64)
  Auto generated number used uniquely to identify the license insurance transaction history.
• LnpLicenseInsKey: integer (int64)
  Indicates unique identifier of the license for the transaction.
• LnpLicenseInsPuid: string
  Maximum Length: 480

  PUID for record. Alternate key used by CRM Import.
• LnpLicenseKey: integer (int64)
  Indicates unique identifier of the license transaction.
• LnpLicensePuid: string
  Maximum Length: 480

  Parent PUID. Alternate key used by CRM Import.
• LnpRecordId: string
  Maximum Length: 50

  Indicates the meaningful transaction identifier.
• LnpRecordKey: integer (int64)
  The unique identifier of the license transaction.
• MigratedDataFlag: string
  Maximum Length: 3

  Default Value: N

  Indicates the In-flight or Historical transaction for data migration.
• RenewalDate: string (date)
  Renewal date of Policy or Bond on the license.
• SuspendDate: string (date)
  Suspension date of Policy or Bond on the license.

{
    "type":"object",
    "properties":{
        "LnpLicenseInsKey":{
            "type":"integer",
            "description":"Indicates unique identifier of the license for the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates the In-flight or Historical transaction for data migration.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "ExpireDate":{
            "type":"string",
            "description":"Expiry date of Policy or Bond on the license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerLink":{
            "maxLength":500,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicenseKey":{
            "type":"integer",
            "description":"Indicates unique identifier of the license transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntentToSuspendDate":{
            "type":"string",
            "description":"Intent to suspend policy notice date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InsuranceType":{
            "maxLength":360,
            "type":"string",
            "description":"Type of insurance on license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicensePercentage":{
            "type":"integer",
            "description":"Percentage of voting stock in company.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "InsuranceFactRec":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of insurance associated with state license.",
            "nullable":true,
            "x-queryable":true
        },
        "IntLastUpdDt":{
            "type":"string",
            "description":"The date last updated by 3rd party system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the 3rd party integration.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicenseInsPuid":{
            "maxLength":480,
            "type":"string",
            "description":"PUID for record.  Alternate key used by CRM Import.",
            "nullable":false,
            "x-queryable":true
        },
        "SuspendDate":{
            "type":"string",
            "description":"Suspension date of Policy or Bond on the license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of license issued.",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerAmt":{
            "type":"integer",
            "description":"Coverage amount on bond or policy on the license.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "InsurerCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code associated with insurer on license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicQualifierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of qualifying individual on the 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":"Parent PUID.  Alternate key used by CRM Import.",
            "nullable":false,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the meaningful transaction identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "Exemptlongdesc":{
            "type":"string",
            "description":"Long description of worker???s compensation exemption.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LicQualifierNameType":{
            "maxLength":20,
            "type":"string",
            "description":"Type of qualifier bond on the bond.",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerPolicyNo":{
            "maxLength":30,
            "type":"string",
            "description":"Policy number issued by insurer on the license.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseInsuranceKey":{
            "type":"integer",
            "description":"Auto generated unique number used to identify the license.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"Issue date of Policy or Bond on the license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the license transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LicenseSetupCode":{
            "maxLength":30,
            "type":"string",
            "description":"Setup code identifying segments usages on the license.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "type":"string",
            "description":"Renewal date of Policy or Bond on the license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CancelDate":{
            "type":"string",
            "description":"Cancellation date of Policy or Bond on the license.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Exempt":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the contractor is exempt for workers compensation insurance.",
            "nullable":true,
            "x-queryable":true
        },
        "InsurerName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the insurer on the contractor license.",
            "nullable":true,
            "x-queryable":true
        },
        "Exemptdesc":{
            "maxLength":500,
            "type":"string",
            "description":"Description of worker???s compensation exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpLicenseHistKey":{
            "type":"integer",
            "description":"Auto generated number used uniquely to identify the license transaction history.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LnpLicenseInsHistKey":{
            "type":"integer",
            "description":"Auto generated number used uniquely to identify the license insurance transaction history.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LicenseKey":{
            "type":"integer",
            "description":"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"
    }
}

Links

captureContractorSnapshot

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRecordContractorHistories/action/captureContractorSnapshot

Create a contractor history

Back to Top