Jump to

• Request
• Response

Get my inspection-ready permit

get

/fscmRestApi/resources/11.13.18.05/publicSectorMyInspectionsPermits/{publicSectorMyInspectionsPermitsUniqID}

Request

Path Parameters

• publicSectorMyInspectionsPermitsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LnpRecordKey and LnpRecordId ---for the My Permits Ready for Inspections resource and used to uniquely identify an instance of My Permits Ready for Inspections. The client should not generate the hash key value. Instead, the client should query on the My Permits Ready for Inspections collection resource with a filter on the primary key values in order to navigate to a specific instance of My Permits Ready for Inspections.
  
  For example: publicSectorMyInspectionsPermits?q=LnpRecordKey=<value1>;LnpRecordId=<value2>

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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorMyInspectionsPermits-item-response

Type: object

Show Source

• Applicant: integer (int64)
  Title: Applicant

  Read Only: true

  The party ID of the person applying for the application.
• BusDbaBusinessName: string
  Read Only: true

  Maximum Length: 100

  The doing business as (DBA) name for the business entity.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The classification of the permit type.
• Description: string
  Read Only: true

  Maximum Length: 1000

  The description of the applicant record.
• EmailAddress1: string
  Read Only: true

  Maximum Length: 320

  The primary contact's email address.
• FormattedAddr: string
  Read Only: true

  Maximum Length: 544

  The primary address and city of the primary parcel or address associated with the permit.
• InspectionGroup: string
  Read Only: true

  Maximum Length: 15

  The unique alphanumeric code or short name for the inspection group associated with the permit type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the application record.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier of the record associated with the permit.
• PersonName: string
  Read Only: true

  Maximum Length: 450

  The primary contact's name.
• PhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The primary contact's phone area code.
• PhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The primary contact's phone country code.
• PhoneExtension: string
  Read Only: true

  Maximum Length: 20

  The primary contact's phone extension.
• PhoneNumber: string
  Read Only: true

  Maximum Length: 40

  The primary contact's phone number.
• PrimaryFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the record is a primary application that has one or more subapplications. When a permit is created, the default value is N or no.
• PrimaryRecordKey: integer (int64)
  Read Only: true

  The unique identifier of the primary record.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The unique alphanumeric code or short name for the permit type.
• RecordTypeCode: string
  Read Only: true

  Maximum Length: 20

  The description of the permit type.
• Status: string
  Read Only: true

  Maximum Length: 15

  The status of the applicant record.
• SubapplicationFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the record is a subapplication or child of a primary application. When a permit is created, the default value is N or no.
• 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.
• SystemStatus: string
  Read Only: true

  Maximum Length: 15

  The predefined system status to which the record status maps.
• VersionType: string
  Read Only: true

  Maximum Length: 1

  The version of the permit. Values are origination, amendment, and renewal.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification for the transaction type, which indicates that the preapplication process is included in addition to the hearing process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"15",
            "type":"string",
            "description":"The status of the applicant record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The predefined system status to which the record status maps.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the application record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "maxLength":"450",
            "type":"string",
            "description":"The primary contact's name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is a primary application that has one or more subapplications. When a permit is created, the default value is N or no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the applicant record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "maxLength":"100",
            "type":"string",
            "description":"The doing business as (DBA) name for the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress1":{
            "maxLength":"320",
            "type":"string",
            "description":"The primary contact's email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record associated with the permit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionType":{
            "maxLength":"1",
            "type":"string",
            "description":"The version of the permit. Values are origination, amendment, and renewal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":"20",
            "type":"string",
            "description":"The primary contact's phone extension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The primary contact's phone country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The primary contact's phone area code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The description of the permit type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the permit type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubapplicationFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is a subapplication or child of a primary application. When a permit is created, the default value is N or no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the permit type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddr":{
            "maxLength":"544",
            "type":"string",
            "description":"The primary address and city of the primary parcel or address associated with the permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the primary record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The primary contact's phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InspectionGroup":{
            "maxLength":"15",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the inspection group associated with the permit type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "title":"Applicant",
            "type":"integer",
            "description":"The party ID of the person applying for the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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