Jump to

• Request
• Response

Get a plan review communication item

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCommunications/{publicSectorPlanReviewCommunicationsUniqID}

Request

Path Parameters

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

Type: object

Show Source

• AgencyName: string
  Title: Agency Name

  Read Only: true

  Maximum Length: 100

  The agency name of the public sector entity to which this plan review communication applies.
• Applicant: integer (int64)
  Read Only: true

  The unique identifer for an applicant.
• ApplicantUsername: string
  Title: Applicant User ID

  Read Only: true

  The user ID for an applicant.
• CreatedBy: string
  Title: Plan Check Coordinator User ID

  Read Only: true

  Maximum Length: 64

  The user who created the plan review cycle.
• CycleCount: integer (int32)
  Title: Plan Review Cycle

  Read Only: true

  The number specifying each plan review cycle.
• Decision: string
  Title: Decision

  Read Only: true

  Maximum Length: 15

  The decision status for the plan review cycle.
• EmailAddress1: string
  Title: Applicant Email

  Read Only: true

  Maximum Length: 320

  The email address for the applicant.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 255

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

  The unique identifer for a permit record.
• PccEmail: string
  Title: Plan Check Coordinator Email

  The email address for the plan coordinator.
• PccName: string
  Title: Plan Check Coordinator Name

  The name of the plan coordinator.
• PersonName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

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

  The unique identifer for a plan review cycle.
• PlanReviewLink: string
  Title: Plan Review URL

  Read Only: true

  The URL to the plan review page for the given permit.
• PlanReviewName: string
  Title: Plan Review Name

  Read Only: true

  Maximum Length: 100

  The name of the plan review.
• RecordType: string
  Title: Permit Type

  Read Only: true

  Maximum Length: 100

  The type of permit. For example, a residential addition.
• ReviewClosedDttm: string (date-time)
  Title: Decision Date

  Read Only: true

  The date when the plan review cycle was closed.
• ReviewOpenBy: integer (int64)
  Read Only: true

  The user who opened the plan review cycle.
• ReviewStatus: string
  Title: Plan Review Cycle Status

  Read Only: true

  Maximum Length: 15

  The review status for the plan review cycle.

{
    "type":"object",
    "properties":{
        "AgencyName":{
            "title":"Agency Name",
            "maxLength":100,
            "type":"string",
            "description":"The agency name of the public sector entity to which this plan review communication applies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Permit",
            "maxLength":255,
            "type":"string",
            "description":"The permit record identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PccName":{
            "title":"Plan Check Coordinator Name",
            "type":"string",
            "description":"The name of the plan coordinator.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Applicant Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Plan Check Coordinator User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the plan review cycle.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewClosedDttm":{
            "title":"Decision Date",
            "type":"string",
            "description":"The date when the plan review cycle was closed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewLink":{
            "title":"Plan Review URL",
            "type":"string",
            "description":"The URL to the plan review page for the given permit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URL":"Y"
            },
            "x-queryable":true
        },
        "EmailAddress1":{
            "title":"Applicant Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address for the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "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
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifer for a permit record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CycleCount":{
            "title":"Plan Review Cycle",
            "type":"integer",
            "description":"The number specifying each plan review cycle.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "Decision":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The decision status for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewKey":{
            "type":"integer",
            "description":"The unique identifer for a plan review cycle.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecordType":{
            "title":"Permit Type",
            "maxLength":100,
            "type":"string",
            "description":"The type of permit. For example, a residential addition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewStatus":{
            "title":"Plan Review Cycle Status",
            "maxLength":15,
            "type":"string",
            "description":"The review status for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantUsername":{
            "title":"Applicant User ID",
            "type":"string",
            "description":"The user ID for an applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PlanReviewName":{
            "title":"Plan Review Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the plan review.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PccEmail":{
            "title":"Plan Check Coordinator Email",
            "type":"string",
            "description":"The email address for the plan coordinator.",
            "nullable":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The unique identifer for an applicant.",
            "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