Update a record extension
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRecordExtensions/{LnpRecordKey}
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.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CancelOpenTask: string
Indicates that the open inspection and open review can be canceled.
-
CurrentTransFlag: string
Maximum Length:
1
Indicates if the transaction is master transaction. -
ExpirationDate: string
(date-time)
The date when the record expires.
-
ExpirationStatus: string
Maximum Length:
15
Indicates the expiration status of the record. -
InsCommenceAteDate: string
(date-time)
Indicates the date that the inspection commencement will be about to expire.
-
InsCommenceExpDate: string
(date-time)
Indicates the date that the inspection commencement will expire.
-
InsCommenceGraceDate: string
(date-time)
Indicates the date that the inspection commencement can be extended.
-
InsCommencementDateOption: string
Maximum Length:
30
Indicates the commencement date of the initial inspection. -
InspCommenceOption: string
Indicates the commencement date of the initial inspection.
-
InspSchPassDate: string
Maximum Length:
255
Indicates the inspection scheduled date or inspection passed date. -
InsScheduledDate: string
(date-time)
Indicates the inspection schedule date.
-
IsExtensionAllowed: boolean
The switch to indicate if the record is allowed to extend.
-
LevelOneTrans: integer
(int64)
Indicates the transaction level.
-
LicenseStatus: string
Maximum Length:
30
Indicates the License status. -
NewExpirationDate: string
(date-time)
The new expiration date for the record extension.
-
NumberOfExtensions: integer
Indicates the number of extensions allowed for the record.
-
OriginalIssueDate: string
(date-time)
Indicates the original issue date.
-
Status: string
Maximum Length:
15
The record status.
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 : publicSectorRecordExtensions-item-response
Type:
Show Source
object
-
AttributeCategory: string
Read Only:
true
Maximum Length:30
The unique identifier for a record type. -
CancelOpenTask: string
Indicates that the open inspection and open review can be canceled.
-
CurrentTransFlag: string
Maximum Length:
1
Indicates if the transaction is master transaction. -
ExpirationDate: string
(date-time)
The date when the record expires.
-
ExpirationStatus: string
Maximum Length:
15
Indicates the expiration status of the record. -
InsCommenceAteDate: string
(date-time)
Indicates the date that the inspection commencement will be about to expire.
-
InsCommenceExpDate: string
(date-time)
Indicates the date that the inspection commencement will expire.
-
InsCommenceGraceDate: string
(date-time)
Indicates the date that the inspection commencement can be extended.
-
InsCommencementDateOption: string
Maximum Length:
30
Indicates the commencement date of the initial inspection. -
InspCommenceOption: string
Indicates the commencement date of the initial inspection.
-
InspSchPassDate: string
Maximum Length:
255
Indicates the inspection scheduled date or inspection passed date. -
InsScheduledDate: string
(date-time)
Indicates the inspection schedule date.
-
IsExtensionAllowed: boolean
The switch to indicate if the record is allowed to extend.
-
LevelOneTrans: integer
(int64)
Indicates the transaction level.
-
LicenseStatus: string
Maximum Length:
30
Indicates the License status. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
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. -
NewExpirationDate: string
(date-time)
The new expiration date for the record extension.
-
NumberOfExtensions: integer
Indicates the number of extensions allowed for the record.
-
OriginalIssueDate: string
(date-time)
Indicates the original issue date.
-
Status: string
Maximum Length:
15
The record status.
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.