Jump to

• Request
• Response

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

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The record status.",
            "nullable":false
        },
        "InsCommenceGraceDate":{
            "type":"string",
            "description":"Indicates the date that the inspection commencement can be extended.",
            "format":"date-time",
            "nullable":true
        },
        "NumberOfExtensions":{
            "type":"integer",
            "description":"Indicates the number of extensions allowed for the record.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalIssueDate":{
            "type":"string",
            "description":"Indicates the original issue date.",
            "format":"date-time",
            "nullable":true
        },
        "NewExpirationDate":{
            "type":"string",
            "description":"The new expiration date for the record extension.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "InspSchPassDate":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the inspection scheduled date or inspection passed date.",
            "nullable":true
        },
        "ExpirationStatus":{
            "maxLength":15,
            "type":"string",
            "description":"Indicates the expiration status of the record.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "CurrentTransFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the transaction is master transaction.",
            "nullable":true
        },
        "InsCommenceExpDate":{
            "type":"string",
            "description":"Indicates the date that the inspection commencement will expire.",
            "format":"date-time",
            "nullable":true
        },
        "LevelOneTrans":{
            "type":"integer",
            "description":"Indicates the transaction level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":20
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The date when the record expires.",
            "format":"date-time",
            "nullable":true
        },
        "InsCommenceAteDate":{
            "type":"string",
            "description":"Indicates the date that the inspection commencement will be about to expire.",
            "format":"date-time",
            "nullable":true
        },
        "LicenseStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the License status.",
            "nullable":true
        },
        "IsExtensionAllowed":{
            "type":"boolean",
            "description":"The switch to indicate if the record is allowed to extend.",
            "nullable":true,
            "x-queryable":false
        },
        "InspCommenceOption":{
            "type":"string",
            "description":"Indicates the commencement date of the initial inspection.",
            "nullable":true
        },
        "CancelOpenTask":{
            "type":"string",
            "description":"Indicates that the open inspection and open review can be canceled.",
            "nullable":true
        },
        "InsCommencementDateOption":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the commencement date of the initial inspection.",
            "nullable":true
        },
        "InsScheduledDate":{
            "type":"string",
            "description":"Indicates the inspection schedule date.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorRecordExtensions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The record status.",
            "nullable":false,
            "x-queryable":true
        },
        "InsCommenceGraceDate":{
            "type":"string",
            "description":"Indicates the date that the inspection commencement can be extended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfExtensions":{
            "type":"integer",
            "description":"Indicates the number of extensions allowed for the record.",
            "nullable":true,
            "x-queryable":false
        },
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalIssueDate":{
            "type":"string",
            "description":"Indicates the original issue date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "NewExpirationDate":{
            "type":"string",
            "description":"The new expiration date for the record extension.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspSchPassDate":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the inspection scheduled date or inspection passed date.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationStatus":{
            "maxLength":15,
            "type":"string",
            "description":"Indicates the expiration status of the record.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurrentTransFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the transaction is master transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "InsCommenceExpDate":{
            "type":"string",
            "description":"Indicates the date that the inspection commencement will expire.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LevelOneTrans":{
            "type":"integer",
            "description":"Indicates the transaction level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":20
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The date when the record expires.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InsCommenceAteDate":{
            "type":"string",
            "description":"Indicates the date that the inspection commencement will be about to expire.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the License status.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IsExtensionAllowed":{
            "type":"boolean",
            "description":"The switch to indicate if the record is allowed to extend.",
            "nullable":true,
            "x-queryable":false
        },
        "InspCommenceOption":{
            "type":"string",
            "description":"Indicates the commencement date of the initial inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelOpenTask":{
            "type":"string",
            "description":"Indicates that the open inspection and open review can be canceled.",
            "nullable":true,
            "x-queryable":true
        },
        "InsCommencementDateOption":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the commencement date of the initial inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "InsScheduledDate":{
            "type":"string",
            "description":"Indicates the inspection schedule date.",
            "format":"date-time",
            "nullable":true,
            "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 : 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."
        }
    }
}

Back to Top