Get all inspection communication items
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCommunications
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds an inspection communication item using the specified inspection identifiers.
Finder Variables:- InspectionId; string; The unique identifier for an inspection.
- LnpRecordKey; integer; The unique identifier for a record.
- PrimaryKey: Finds an inspection communication item using the specified inspection identifiers.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyUser; string; Indicates whether the inspection was last modified by an agency user.
- Applicant; integer; The party ID of the person applying for the application.
- ApplicantEmailAddress1; string; The permit applicant email address.
- ApplicantEmailAddress2; string; The permit applicant additional email address.
- ApplicantLoginId; string; The permit applicant login ID.
- ApplicantPersonName; string; The permit applicant name.
- ApplicantPersonNameSuffix; string; The suffix to the permit applicant name.
- ApplicantPhoneAreaCode; string; The area code for the permit applicant phone number.
- ApplicantPhoneCountryCode; string; The country code for the permit applicant phone number.
- ApplicantPhoneExtension; string; The permit applicant phone number extension.
- ApplicantPhoneNumber; string; The permit applicant phone number.
- ApplicantUserId; string; The permit applicant user ID.
- AssessFee; string; Indicates whether fees should be assessed for the inspection.
- ContactEmail; string; The email of the contact at the inspection site.
- ContactName; string; The name of the contact at the inspection site.
- ContactTextMessage; string; The mobile phone number of the contact at the inspection site.
- EstimatedTimeArrival; string; The earliest estimated time of arrival at the building inspection site.
- EstimatedTimeArrivalEnd; string; The latest estimated time of arrival at the building inspection site.
- FeeBalanceDue; number; The fee balance due for the permit.
- FinalInspection; string; Indicates whether this is the final inspection. The default is no.
- InspectionAddress1; string; The first address line of the building inspection site.
- InspectionAddress2; string; The second address line of the building inspection site.
- InspectionCity; string; The city in the address of the building inspection site.
- InspectionCompleteDttm; string; The date and time when the inspection was completed.
- InspectionCountry; string; The country in the address of the building inspection site.
- InspectionCounty; string; The county in the address of the building inspection site.
- InspectionId; string; The unique identifier for an inspection.
- InspectionLocation; string; The location where the inspection will take place.
- InspectionPostalCode; string; The postal code in the address of the building inspection site.
- InspectionProvince; string; The province in the address of the building inspection site.
- InspectionRating; string; The overall rating of the inspection, which is calculated based on a defined rating method.
- InspectionResult; string; The results of the inspection. For example, Pass, Fail, Yes, or No.
- InspectionScore; integer; The calculated total score of the inspection.
- InspectionState; string; The state in the address of the building inspection site.
- InspectionStatus; string; The inspection status description.
- InspectionType; string; The description of the inspection type.
- InspectionUpdateDate; string; The date when the record was last updated.
- InspectorArrival; string; The time when the inspector is expected to arrive for an inspection. The value can be displayed as Date Only, Specific Time, or Time Range, as specified in the agency options.
- InspectorEmail; string; The building inspector email address.
- InspectorId; integer; The inspector assigned to the inspection.
- InspectorLoginId; string; The building inspector login ID.
- InspectorName; string; The name of the inspector.
- InspectorPhone; string; The building inspector phone number.
- InspectorUserId; string; The building inspector user ID.
- LnpRecordId; string; The building permit record identifier. For example, a permit ID with a value of Building Permit ID RA-2017-00029.
- LnpRecordKey; integer; The unique identifier for a permit record.
- NumberMajorViolations; integer; The total number of major violations for the inspection.
- Owner; string; The primary or only owner of the parcel or property.
- OwnerEmailId; string; The parcel owner email address.
- ParcelId; integer; The identifier of the record parcel.
- PermitStatus; string; The status of the permit record.
- PermitStatusDescription; string; The status description of the permit record.
- PermitSystemStatus; string; The status code of the permit record.
- RecordType; string; The type of permit on the inspection schedule page, such as a residential addition.
- RecordTypeId; string; The unique alphanumeric code or short name for the record type.
- ScheduledEndDttm; string; The scheduled inspection end date.
- ScheduledStartDttm; string; The scheduled inspection start date.
- ScheduledTimeRange; string; The Inspection scheduled time range based on the defined setup of the permit type.
- SecondaryOwner; string; The secondary owner of the parcel or property.
- SystemResult; string; The unique alphanumeric code or short name for the inspection result.
- Url; string; The inspection URL used within a communications template.
- UrlLabel; string; The label displayed for an inspection URL used within a communications template.
- WorkflowAssignedDate; string; The date when the workflow task was assigned.
- WorkflowDueDate; string; The workflow task due date.
- WorkflowTaskId; string; The workflow task ID.
- WorkflowTaskName; string; The workflow task name.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
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 : publicSectorInspectionCommunications
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInspectionCommunications-item-response
Type:
Show Source
object
-
AgencyUser: string
Title:
Agency User
Read Only:true
Indicates whether the inspection was last modified by an agency user. -
Applicant: integer
(int64)
Title:
Applicant
Read Only:true
The party ID of the person applying for the application. -
ApplicantEmailAddress1: string
Title:
Applicant Email 1
Read Only:true
Maximum Length:320
The permit applicant email address. -
ApplicantEmailAddress2: string
Title:
Applicant Email 2
Read Only:true
Maximum Length:320
The permit applicant additional email address. -
ApplicantLoginId: string
Read Only:
true
The permit applicant login ID. -
ApplicantPersonName: string
Title:
Applicant Name
Read Only:true
Maximum Length:450
The permit applicant name. -
ApplicantPersonNameSuffix: string
Title:
Applicant Suffix
Read Only:true
Maximum Length:30
The suffix to the permit applicant name. -
ApplicantPhoneAreaCode: string
Title:
Applicant Phone Area Code
Read Only:true
Maximum Length:10
The area code for the permit applicant phone number. -
ApplicantPhoneCountryCode: string
Title:
Applicant Phone Country Code
Read Only:true
Maximum Length:10
The country code for the permit applicant phone number. -
ApplicantPhoneExtension: string
Title:
Applicant Phone Extension
Read Only:true
Maximum Length:20
The permit applicant phone number extension. -
ApplicantPhoneNumber: string
Title:
Applicant Phone
Read Only:true
Maximum Length:40
The permit applicant phone number. -
ApplicantUserId: string
Title:
Applicant User ID
Read Only:true
The permit applicant user ID. -
AssessFee: string
Title:
Assess Fee
Read Only:true
Maximum Length:1
Indicates whether fees should be assessed for the inspection. -
ContactEmail: string
Title:
Contact Email
Read Only:true
Maximum Length:320
The email of the contact at the inspection site. -
ContactName: string
Title:
Location Contact
Read Only:true
Maximum Length:450
The name of the contact at the inspection site. -
ContactTextMessage: string
Title:
Location Contact Mobile Phone
Read Only:true
The mobile phone number of the contact at the inspection site. -
EstimatedTimeArrival: string
(date-time)
Title:
Inspection ETA From
Read Only:true
The earliest estimated time of arrival at the building inspection site. -
EstimatedTimeArrivalEnd: string
(date-time)
Title:
Inspection ETA To
Read Only:true
The latest estimated time of arrival at the building inspection site. -
FeeBalanceDue: number
Title:
Fees Balance Due
The fee balance due for the permit. -
FinalInspection: string
Title:
Final Inspection
Read Only:true
Maximum Length:1
Indicates whether this is the final inspection. The default is no. -
InspectionAddress1: string
Title:
Inspection Address Line 1
Read Only:true
Maximum Length:240
The first address line of the building inspection site. -
InspectionAddress2: string
Title:
Inspection Address Line 2
Read Only:true
Maximum Length:240
The second address line of the building inspection site. -
InspectionCity: string
Title:
Inspection City
Read Only:true
Maximum Length:60
The city in the address of the building inspection site. -
InspectionCompleteDttm: string
(date-time)
Title:
Completion Date
Read Only:true
The date and time when the inspection was completed. -
InspectionCountry: string
Title:
Inspection Country
Read Only:true
Maximum Length:3
The country in the address of the building inspection site. -
InspectionCounty: string
Title:
Inspection County
Read Only:true
Maximum Length:60
The county in the address of the building inspection site. -
InspectionId: string
Title:
Inspection
Read Only:true
Maximum Length:50
The unique identifier for an inspection. -
InspectionLocation: string
Title:
Inspection Location
Read Only:true
Maximum Length:100
The location where the inspection will take place. -
InspectionPostalCode: string
Title:
Inspection Postal Code
Read Only:true
Maximum Length:60
The postal code in the address of the building inspection site. -
InspectionProvince: string
Title:
Inspection Province
Read Only:true
Maximum Length:60
The province in the address of the building inspection site. -
InspectionRating: string
Title:
Rating
Read Only:true
Maximum Length:5
The overall rating of the inspection, which is calculated based on a defined rating method. -
InspectionResult: string
Title:
Result
Read Only:true
Maximum Length:25
The results of the inspection. For example, Pass, Fail, Yes, or No. -
InspectionScore: integer
(int32)
Title:
Score
Read Only:true
The calculated total score of the inspection. -
InspectionState: string
Title:
Inspection State
Read Only:true
Maximum Length:60
The state in the address of the building inspection site. -
InspectionStatus: string
Title:
Inspection Status
Read Only:true
Maximum Length:100
The inspection status description. -
InspectionType: string
Title:
Inspection Type
Read Only:true
Maximum Length:100
The description of the inspection type. -
InspectionUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
InspectorArrival: string
Title:
Inspector Arrival
Read Only:true
Maximum Length:255
The time when the inspector is expected to arrive for an inspection. The value can be displayed as Date Only, Specific Time, or Time Range, as specified in the agency options. -
InspectorEmail: string
Title:
Inspector Email
Read Only:true
The building inspector email address. -
InspectorId: integer
(int64)
Title:
Inspector ID
Read Only:true
The inspector assigned to the inspection. -
InspectorLoginId: string
Read Only:
true
The building inspector login ID. -
InspectorName: string
Title:
Inspector
Read Only:true
Maximum Length:360
The name of the inspector. -
InspectorPhone: string
Title:
Inspector Phone
Read Only:true
The building inspector phone number. -
InspectorUserId: string
Title:
Inspector User ID
Read Only:true
The building inspector user ID. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Permit ID
Read Only:true
Maximum Length:50
The building permit record identifier. For example, a permit ID with a value of Building Permit ID RA-2017-00029. -
LnpRecordKey: integer
Read Only:
true
The unique identifier for a permit record. -
NumberMajorViolations: integer
(int32)
Title:
Major Violation Count
Read Only:true
The total number of major violations for the inspection. -
Owner: string
Title:
Owner
Read Only:true
Maximum Length:150
The primary or only owner of the parcel or property. -
OwnerEmailId: string
Title:
Owner Email
Read Only:true
Maximum Length:50
The parcel owner email address. -
ParcelId: integer
(int64)
Title:
Parcel
Read Only:true
The identifier of the record parcel. -
PermitStatus: string
Title:
Permit Status
Read Only:true
Maximum Length:15
The status of the permit record. -
PermitStatusDescription: string
Title:
Permit Status Description
Read Only:true
Maximum Length:100
The status description of the permit record. -
PermitSystemStatus: string
Title:
Permit System Status
Read Only:true
Maximum Length:15
The status code of the permit record. -
RecordType: string
Title:
Permit Type
Read Only:true
Maximum Length:100
The type of permit on the inspection schedule page, such as a residential addition. -
RecordTypeId: string
Title:
Record Type ID
Read Only:true
Maximum Length:30
The unique alphanumeric code or short name for the record type. -
ScheduledEndDttm: string
(date-time)
Title:
Schedule End Date
Read Only:true
The scheduled inspection end date. -
ScheduledStartDttm: string
(date-time)
Title:
Schedule Start Date
Read Only:true
The scheduled inspection start date. -
ScheduledTimeRange: string
Title:
Inspection Scheduled Time Range
Read Only:true
The Inspection scheduled time range based on the defined setup of the permit type. -
SecondaryOwner: string
Title:
Secondary Owner
Read Only:true
Maximum Length:150
The secondary owner of the parcel or property. -
SystemResult: string
Title:
System Result
Read Only:true
Maximum Length:20
The unique alphanumeric code or short name for the inspection result. -
Url: string
Title:
URL
Read Only:true
The inspection URL used within a communications template. -
UrlLabel: string
Title:
Communications URL Label
Read Only:true
The label displayed for an inspection URL used within a communications template. -
WorkflowAssignedDate: string
Title:
Workflow Assigned Date
Read Only:true
The date when the workflow task was assigned. -
WorkflowDueDate: string
Read Only:
true
The workflow task due date. -
WorkflowTaskId: string
Title:
Workflow Task ID
Read Only:true
The workflow task ID. -
WorkflowTaskName: string
Title:
Workflow Task Name
Read Only:true
The workflow task name.
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.