Get an record contractor license fact
get
/fscmRestApi/resources/11.13.18.05/publicSectorPzRecords/{LnpRecordKey}/child/RecordContractorLicense/{LnpLicenseKey}/child/RecordContractorLicFact/{LnpLicenseFactKey}
Request
Path Parameters
-
LnpLicenseFactKey(required): integer(int64)
The auto generated number used uniquely to identify the license on the transaction.
-
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.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
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 : publicSectorPzRecords-RecordContractorLicense-RecordContractorLicFact-item-response
Type:
Show Source
object
-
CntrctrLicFactRec: string
Maximum Length:
30
This Identifies the type of fact record for the data. -
IntegrationSource: string
Title:
Integration Name
Maximum Length:30
This identifies 3rd party integration. -
IntLastUpdDt: string
(date)
Title:
Last Updated
The date last updated by 3rd party???s system. -
LicenseFactKey: integer
(int64)
The system generated number used uniquely to identify the license.
-
LicenseKey: integer
(int64)
This field Indicates the unique identifier of the license.
-
LicenseNumber: string
Maximum Length:
50
Default Value:The license number issued by the government or the agency. -
LicenseSetupCode: string
Maximum Length:
30
Default Value:The setup code that identifies segments usage on the license. -
LicenseType: string
Maximum Length:
30
Default Value:The type of the license issued. -
LicFactCode: string
Maximum Length:
30
This identifies the code for this fact data. -
LicFactCodeValue: string
Maximum Length:
500
This Identifies the value for this fact data. -
LicFactDate: string
(date)
This Identifies the date for this fact data.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpLicenseFactKey: integer
(int64)
The auto generated number used uniquely to identify the license on the transaction.
-
LnpLicenseFactPuid: string
Maximum Length:
480
The public unique identifier for the license fact, which is an alternate key used by the CRM Import process. -
LnpLicenseKey: integer
(int64)
Title:
License Number
This field Indicates the unique identifier of the license for the transaction. -
LnpLicensePuid: string
Maximum Length:
480
The parent unique identifier, which is an alternate key used by the CRM Import process. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
This field Indicates the meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Title:
Record ID
The unique identifier for the related transaction.
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.