Create a set of contractor license fact
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact
Request
Path Parameters
-
LnpLicenseKey(required): integer(int64)
The system generated number used uniquely to identify the license on the transaction.
-
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CntrctrLicFactRec: string
Maximum Length:
30
The type of fact record for the data. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
Identifies the third party integration. -
IntLastUpdDt: string
(date)
Title:
Last Updated
The date last updated by third party???s system. -
LicenseFactKey: integer
(int64)
The system generated number used uniquely to identify the license.
-
LicenseKey: integer
(int64)
The unique identifier of the license.
-
LicenseNumber: string
Maximum Length:
50
Default Value:The license number issued by the government. -
LicenseSetupCode: string
Maximum Length:
30
Default Value:Setup code that identifies segments usage on the license. -
LicenseType: string
Maximum Length:
30
Default Value:The type of the license issued. -
LicFactCode: string
Maximum Length:
30
The code for this fact data. -
LicFactCodeValue: string
Maximum Length:
500
The value for this fact data. -
LicFactDate: string
(date)
The date for this fact data.
-
LnpLicenseFactKey: integer
(int64)
The auto generated number used uniquely to identify the license on the transaction.
-
LnpLicenseFactPuid: string
Maximum Length:
480
The public unique identifier for the license fact, which is an alternate key used by the CRM Import process. -
LnpLicenseKey: integer
(int64)
Title:
License Number
The unique identifier of the license transaction. -
LnpLicensePuid: string
Maximum Length:
480
The parent unique identifier, which is an alternate key used by the CRM Import process. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier for the related transaction.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorRecords-RecordContractorLicense-RecordContractorLicFact-item-response
Type:
Show Source
object
-
CntrctrLicFactRec: string
Maximum Length:
30
The type of fact record for the data. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
Identifies the third party integration. -
IntLastUpdDt: string
(date)
Title:
Last Updated
The date last updated by third party???s system. -
LicenseFactKey: integer
(int64)
The system generated number used uniquely to identify the license.
-
LicenseKey: integer
(int64)
The unique identifier of the license.
-
LicenseNumber: string
Maximum Length:
50
Default Value:The license number issued by the government. -
LicenseSetupCode: string
Maximum Length:
30
Default Value:Setup code that identifies segments usage on the license. -
LicenseType: string
Maximum Length:
30
Default Value:The type of the license issued. -
LicFactCode: string
Maximum Length:
30
The code for this fact data. -
LicFactCodeValue: string
Maximum Length:
500
The value for this fact data. -
LicFactDate: string
(date)
The date for this fact data.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpLicenseFactKey: integer
(int64)
The auto generated number used uniquely to identify the license on the transaction.
-
LnpLicenseFactPuid: string
Maximum Length:
480
The public unique identifier for the license fact, which is an alternate key used by the CRM Import process. -
LnpLicenseKey: integer
(int64)
Title:
License Number
The unique identifier of the license transaction. -
LnpLicensePuid: string
Maximum Length:
480
The parent unique identifier, which is an alternate key used by the CRM Import process. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier for the related transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.