Get a record with details
get
/fscmRestApi/resources/11.13.18.05/publicSectorLinkedRecords/{LnpRecordKey}
Request
Path Parameters
-
LnpRecordKey(required): integer
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 : publicSectorLinkedRecords-item-response
Type:
Show Source
object
-
AboutToExpireDate: string
(date-time)
Read Only:
true
The date that is calculated based on the number of days remaining for the record be expire. -
Address1: string
Read Only:
true
Maximum Length:240
The first or main address. -
Address2: string
Read Only:
true
Maximum Length:240
The second address, if present. -
Applicant: integer
(int64)
Read Only:
true
The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit. -
ApplicantBizProfileId: integer
(int64)
Read Only:
true
The unique identifier of the applicant business profile when the applicant is a business entity. -
ApplicantCriteria: string
Read Only:
true
Maximum Length:40
The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit in simple format. -
ApplicantProfileId: integer
(int64)
Read Only:
true
The unique identifier of the applicant user profile. -
City: string
Read Only:
true
Maximum Length:60
The city in the parcel address. -
Classification: string
Read Only:
true
Maximum Length:3
The record classification. The classifications can be permit, business license, professional license, or planning and zoning. -
CreatedByName: string
Read Only:
true
Maximum Length:240
The name of the applicant who created the application. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CreationDateCriteria: string
Read Only:
true
Maximum Length:16
The formatted date when the record was created. -
CurrencyCode: string
Read Only:
true
Maximum Length:3
The currency code used for applying payments. -
Description: string
Read Only:
true
Maximum Length:1000
The record description. -
ExpirationAmend: string
Read Only:
true
Maximum Length:1
Indicates whether amendment is enabled for the license type. -
ExpirationDate: string
(date-time)
Read Only:
true
The date when the record expires. -
ExpirationDateCriteria: string
Read Only:
true
Maximum Length:16
The formatted date when the record expires. -
ExpirationGraceDate: string
(date-time)
Read Only:
true
Indicates the new date that the application can be extended. -
ExpirationRenew: string
Read Only:
true
Maximum Length:1
Indicates whether renewal is enabled for the license type. -
IssueDate: string
(date-time)
Read Only:
true
The date when the application was issued. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdateDateCriteria: string
Read Only:
true
Maximum Length:16
The formatted date when the record was last updated. -
Latitude: number
Read Only:
true
The geographical latitude location of the parcel address. -
LayoutVersion: string
Read Only:
true
Maximum Length:30
The layout version used for this record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
Maximum Length:50
The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey: integer
Read Only:
true
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. -
Longitude: number
Read Only:
true
The geographical longitude location of the parcel address. -
PaymentInProcess: number
Read Only:
true
The total fee amount that is processing through the payment service. -
PersonName: string
Read Only:
true
Maximum Length:450
The name of the person who completed the application process. -
PostalCode: string
Read Only:
true
Maximum Length:60
The postal code in the parcel address. -
PrimaryContact: string
Read Only:
true
Maximum Length:450
The name of the person who marked a primary contact for the application. -
PrimaryFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the record is primary. -
PrimaryMeaning: string
Read Only:
true
Maximum Length:80
The calculated field to show the primary meaning from the lookup table. -
PrimaryRecordId: string
Read Only:
true
Maximum Length:50
The parent record ID for a subrecord. -
PrimaryRecordKey: integer
(int64)
Read Only:
true
The primary record key for a subrecord. -
ReceivedDate: string
(date-time)
Read Only:
true
The date on which the transaction was received. -
RecordType: string
Read Only:
true
Maximum Length:100
The user-friendly name for the record type. -
RecordTypeCode: string
Read Only:
true
Maximum Length:20
The unique alphanumeric code or short name for the record type. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The unique identifier for a record type. -
ReissueDate: string
(date-time)
Read Only:
true
The date when the application was reissued. -
State: string
Read Only:
true
Maximum Length:60
The state in the parcel address. -
Status: string
Read Only:
true
Maximum Length:15
The record status. -
SubapplicationFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the record is a subapplication. -
SubapplicationMeaning: string
Read Only:
true
Maximum Length:80
The calculated field to show the subrecord meaning from the lookup table. -
Subclassification: string
Read Only:
true
Maximum Length:10
The subclassification for the transaction type, which indicates that the preapplication process is included in addition to the hearing process. -
SubmitDate: string
(date-time)
Read Only:
true
The date when the record was submitted. -
SubmitDateCriteria: string
Read Only:
true
Maximum Length:16
The formatted date when the record was submitted. -
SystemStatus: string
Read Only:
true
Maximum Length:15
The predefined system status to which the record status maps. -
Total: number
Read Only:
true
The total amount of fees for this record. -
TotalCriteria: string
Read Only:
true
Maximum Length:40
The total amount of fees for this record in simple format. -
TotalDue: number
Read Only:
true
The amount of fees that are currently due for this record. -
TotalDueCount: number
Read Only:
true
The total number of fee items that are currently due for this record. -
TotalDueCriteria: string
Read Only:
true
Maximum Length:40
The amount of fees that are currently due for this record in simple format. -
TotalPaid: number
Read Only:
true
The amount paid as the total fees for this record. -
VersionType: string
Read Only:
true
Maximum Length:1
The version of the permit. Values are original, amendment, and renewal. -
VersionTypeDesc: string
Read Only:
true
Maximum Length:80
The description for the version type.
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.