Jump to

• Request
• Response

Get a permit plan review coordinator attachment communications item

get

/fscmRestApi/resources/11.13.18.05/publicSectorPermitPlanCoordinatorAttachmentCommunications/{publicSectorPermitPlanCoordinatorAttachmentCommunicationsUniqID}

Request

Path Parameters

• publicSectorPermitPlanCoordinatorAttachmentCommunicationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LnpRecordKey and AttachmentId ---for the Permit Plan Review Coordinator Attachment Communications resource and used to uniquely identify an instance of Permit Plan Review Coordinator Attachment Communications. The client should not generate the hash key value. Instead, the client should query on the Permit Plan Review Coordinator Attachment Communications collection resource with a filter on the primary key values in order to navigate to a specific instance of Permit Plan Review Coordinator Attachment Communications.
  
  For example: publicSectorPermitPlanCoordinatorAttachmentCommunications?q=LnpRecordKey=<value1>;AttachmentId=<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 : publicSectorPermitPlanCoordinatorAttachmentCommunications-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

  The first or main address.
• Address2: string
  Title: Address Line 2

  Read Only: true

  Maximum Length: 240

  The second address, if present.
• ApplicantId: integer (int64)
  Read Only: true

  The party ID of the person applying for a permit.
• ApplicantName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The name of the applicant.
• AttachmentId: integer (int64)
  Read Only: true

  The unique identifier for a permit attachment.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city in the parcel address.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country in the address.
• County: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county in the parcel address.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the plan review cycle.
• CreationDate: string (date-time)
  Title: Uploaded On

  Read Only: true

  The date and time when the attachment was created.
• CycleCount: integer (int32)
  Title: Plan Review Cycle

  Read Only: true

  The numbering for each plan review cycle.
• CycleDays: integer (int32)
  Title: Cycle Days

  Read Only: true

  The number of days that the plan review cycle was open or in progress.
• DocCategory: string
  Title: Document Category

  Read Only: true

  Maximum Length: 30

  The value that will be displayed for the document category related to an attachment.
• DocCategoryCode: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the document category.
• DocSubcategory: string
  Title: Document Subcategory

  Read Only: true

  Maximum Length: 30

  The value that will be displayed for document subcategory related to an attachment.
• DocSubcategoryCode: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the document subcategory.
• ElectronicPlanReview: string
  Title: Electronic Review

  Read Only: true

  Maximum Length: 1

  Indicates whether the plan review has been performed for a document attachment. The default value is N for no.
• FileDescription: string
  Title: File Description

  Read Only: true

  Maximum Length: 100

  The description of the attachment.
• FileName: string
  Title: File Name

  Read Only: true

  Maximum Length: 255

  The name of the attached file.
• FileSize: integer (int64)
  Title: File Size

  Read Only: true

  The size of the attached file.
• FileType: string
  Title: File Type

  Read Only: true

  Maximum Length: 100

  The file type of attachment, such as PDF or text.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Application ID

  Read Only: true

  Maximum Length: 50

  The permit record identifier.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier for a permit.
• PermitDescription: string
  Title: Application Description

  Read Only: true

  Maximum Length: 1000

  The permit description.
• PermitStatus: string
  Title: Application Status

  Read Only: true

  Maximum Length: 15

  The permit status.
• PermitStatusCode: string
  Read Only: true

  Maximum Length: 15

  The permit status code.
• PermitStatusDescr: string
  Title: Application Status Description

  Read Only: true

  Maximum Length: 100

  The status description of the permit record.
• PlanCoordinatorDisplayName: string
  Title: Plan Check Coordinator Name

  Read Only: true

  The display name of plan coordinators as seen within the PSCR application.
• PlanCoordinatorEmailAddress: string
  Title: Plan Check Coordinator Email

  Read Only: true

  The list of plan coordinator email addresses for which an email communication can be sent.
• PlanCoordinatorUsername: string
  Title: Plan Check Coordinator User ID

  Read Only: true

  The list of plan coordinator user IDs for which an in-product notification communication can be sent.
• PlanReviewDecision: string
  Title: Plan Review Cycle Decision

  Read Only: true

  Maximum Length: 35

  The decision status for the plan review cycle.
• PlanReviewDecisionCode: string
  Read Only: true

  Maximum Length: 15

  The decision status code for the plan review cycle.
• PlanReviewDecisionDescr: string
  Title: Plan Review Cycle Decision Description

  Read Only: true

  Maximum Length: 100

  The decision description of the plan review record.
• PlanReviewId: string
  Read Only: true

  Maximum Length: 12

  The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1.
• PlanReviewName: string
  Title: Plan Review Name

  Read Only: true

  Maximum Length: 100

  The name of the plan review.
• PlanReviewStatus: string
  Title: Plan Review Cycle Status

  Read Only: true

  Maximum Length: 30

  The review status for the plan review cycle.
• PlanReviewStatusCode: string
  Read Only: true

  Maximum Length: 15

  The review status code for the plan review cycle.
• PlanReviewStatusDescr: string
  Title: Plan Review Cycle Status Description

  Read Only: true

  Maximum Length: 100

  The status description of the plan review record.
• PlanReviewType: string
  Title: Plan Review Type

  Read Only: true

  Maximum Length: 11

  The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the parcel address.
• Province: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  The province in the parcel address.
• RecordType: string
  Title: Application Type

  Read Only: true

  Maximum Length: 100

  The user-friendly name for the permit type.
• ReviewClosedBy: integer (int64)
  Title: Review Closed By

  Read Only: true

  The user who closed the plan review cycle.
• ReviewClosedDttm: string (date-time)
  Title: Plan Review Closed Date

  Read Only: true

  The date when the plan review cycle was closed.
• ReviewDueDate: string (date-time)
  Title: Plan Review Cycle Due Date

  Read Only: true

  The date by which the plan review must be completed.
• ReviewOpenBy: integer (int64)
  Read Only: true

  The user who opened the plan review cycle.
• ReviewOpenDttm: string (date-time)
  Title: Plan Review Open Date

  Read Only: true

  The date when the plan review cycle was opened.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state in the parcel address.

{
    "type":"object",
    "properties":{
        "PlanReviewStatusDescr":{
            "title":"Plan Review Cycle Status Description",
            "maxLength":"100",
            "type":"string",
            "description":"The status description of the plan review record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Uploaded On",
            "type":"string",
            "description":"The date and time when the attachment was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanCoordinatorUsername":{
            "title":"Plan Check Coordinator User ID",
            "type":"string",
            "description":"The list of plan coordinator user IDs for which an in-product notification communication can be sent.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ElectronicPlanReview":{
            "title":"Electronic Review",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the plan review has been performed for a document attachment. The default value is N for no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocCategoryCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewStatusCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The review status code for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantId":{
            "type":"integer",
            "description":"The party ID of the person applying for a permit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanCoordinatorEmailAddress":{
            "title":"Plan Check Coordinator Email",
            "type":"string",
            "description":"The list of plan coordinator email addresses for which an email communication can be sent.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantName":{
            "title":"Applicant Name",
            "maxLength":"450",
            "type":"string",
            "description":"The name of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewType":{
            "title":"Plan Review Type",
            "maxLength":"11",
            "type":"string",
            "description":"The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a permit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileDescription":{
            "title":"File Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country in the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitStatusDescr":{
            "title":"Application Status Description",
            "maxLength":"100",
            "type":"string",
            "description":"The status description of the permit record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attached file.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanReviewDecisionCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The decision status code for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the attached file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewClosedBy":{
            "title":"Review Closed By",
            "type":"integer",
            "description":"The user who closed the plan review cycle.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocSubcategoryCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document subcategory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewStatus":{
            "title":"Plan Review Cycle Status",
            "maxLength":"30",
            "type":"string",
            "description":"The review status for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewOpenBy":{
            "type":"integer",
            "description":"The user who opened the plan review cycle.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanCoordinatorDisplayName":{
            "title":"Plan Check Coordinator Name",
            "type":"string",
            "description":"The display name of plan coordinators as seen within the PSCR application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for the permit type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewName":{
            "title":"Plan Review Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the plan review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewDecisionDescr":{
            "title":"Plan Review Cycle Decision Description",
            "maxLength":"100",
            "type":"string",
            "description":"The decision description of the plan review record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocCategory":{
            "title":"Document Category",
            "maxLength":"30",
            "type":"string",
            "description":"The value that will be displayed for the document category related to an attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitStatusCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The permit status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocSubcategory":{
            "title":"Document Subcategory",
            "maxLength":"30",
            "type":"string",
            "description":"The value that will be displayed for document subcategory related to an attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitDescription":{
            "title":"Application Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The permit description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":"50",
            "type":"string",
            "description":"The permit record identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewClosedDttm":{
            "title":"Plan Review Closed Date",
            "type":"string",
            "description":"The date when the plan review cycle was closed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleDays":{
            "title":"Cycle Days",
            "type":"integer",
            "description":"The number of days that the plan review cycle was open or in progress.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewDueDate":{
            "title":"Plan Review Cycle Due Date",
            "type":"string",
            "description":"The date by which the plan review must be completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewDecision":{
            "title":"Plan Review Cycle Decision",
            "maxLength":"35",
            "type":"string",
            "description":"The decision status for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleCount":{
            "title":"Plan Review Cycle",
            "type":"integer",
            "description":"The numbering for each plan review cycle.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique identifier for a permit attachment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FileType":{
            "title":"File Type",
            "maxLength":"100",
            "type":"string",
            "description":"The file type of attachment, such as PDF or text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewOpenDttm":{
            "title":"Plan Review Open Date",
            "type":"string",
            "description":"The date when the plan review cycle was opened.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitStatus":{
            "title":"Application Status",
            "maxLength":"15",
            "type":"string",
            "description":"The permit status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewId":{
            "maxLength":"12",
            "type":"string",
            "description":"The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1.",
            "nullable":true,
            "readOnly":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