Get all inspection communication items
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCommunications
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorInspectionCommunications
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInspectionCommunications-item
Type:
Show Source
object
-
Applicant(optional):
integer(int64)
Title:
Applicant
The party ID of the person applying for the application. -
ApplicantEmailAddress1(optional):
string
Title:
Applicant Email 1
Maximum Length:320
The permit applicant email address. -
ApplicantEmailAddress2(optional):
string
Title:
Applicant Email 2
Maximum Length:320
The permit applicant additional email address. -
ApplicantLoginId(optional):
string
The permit applicant login ID.
-
ApplicantPersonName(optional):
string
Title:
Applicant Name
Maximum Length:450
The permit applicant name. -
ApplicantPersonNameSuffix(optional):
string
Title:
Applicant Suffix
Maximum Length:30
The suffix to the permit applicant name. -
ApplicantPhoneAreaCode(optional):
string
Title:
Applicant Phone Area Code
Maximum Length:10
The area code for the permit applicant phone number. -
ApplicantPhoneCountryCode(optional):
string
Title:
Applicant Phone Country Code
Maximum Length:10
The country code for the permit applicant phone number. -
ApplicantPhoneExtension(optional):
string
Title:
Applicant Phone Extension
Maximum Length:20
The permit applicant phone number extension. -
ApplicantPhoneNumber(optional):
string
Title:
Applicant Phone
Maximum Length:40
The permit applicant phone number. -
ApplicantUserId(optional):
string
Title:
Applicant User ID
The permit applicant user ID. -
ContactEmail(optional):
string
Title:
Contact Email
Maximum Length:320
The email of the contact at the inspection site. -
ContactName(optional):
string
Title:
Location Contact
Maximum Length:450
The name of the contact at the inspection site. -
EstimatedTimeArrival(optional):
string(date-time)
Title:
Inspection ETA From
The earliest estimated time of arrival at the building inspection site. -
EstimatedTimeArrivalEnd(optional):
string(date-time)
Title:
Inspection ETA To
The latest estimated time of arrival at the building inspection site. -
InspectionAddress1(optional):
string
Title:
Inspection Address Line 1
Maximum Length:240
The first address line of the building inspection site. -
InspectionAddress2(optional):
string
Title:
Inspection Address Line 2
Maximum Length:240
The second address line of the building inspection site. -
InspectionCity(optional):
string
Title:
Inspection City
Maximum Length:60
The city in the address of the building inspection site. -
InspectionCompleteDttm(optional):
string(date-time)
Title:
Completion Date
The date and time when the inspection was completed. -
InspectionCountry(optional):
string
Title:
Inspection Country
Maximum Length:3
The country in the address of the building inspection site. -
InspectionCounty(optional):
string
Title:
Inspection County
Maximum Length:60
The county in the address of the building inspection site. -
InspectionId(optional):
string
Title:
Inspection
Maximum Length:50
The unique identifier for an inspection. -
InspectionLocation(optional):
string
Title:
Inspection Location
Maximum Length:100
The location where the inspection will take place. -
InspectionPostalCode(optional):
string
Title:
Inspection Postal Code
Maximum Length:60
The postal code in the address of the building inspection site. -
InspectionProvince(optional):
string
Title:
Inspection Province
Maximum Length:60
The province in the address of the building inspection site. -
InspectionRating(optional):
string
Title:
Rating
Maximum Length:5
The overall rating of the inspection, which is calculated based on a defined rating method. -
InspectionResult(optional):
string
Title:
Result
Maximum Length:15
The results of the inspection. For example, Pass, Fail, Yes, or No. -
InspectionScore(optional):
integer(int32)
Title:
Score
The calculated total score of the inspection. -
InspectionState(optional):
string
Title:
Inspection State
Maximum Length:60
The state in the address of the building inspection site. -
InspectionStatus(optional):
string
Title:
Inspection Status
Maximum Length:100
The inspection status description. -
InspectionType(optional):
string
Title:
Inspection Type
Maximum Length:100
The unique identifier for an inspection type. -
InspectorEmail(optional):
string
Title:
Inspector Email
The building inspector email address. -
InspectorId(optional):
integer(int64)
Title:
Inspector ID
The inspector assigned to the inspection. -
InspectorLoginId(optional):
string
The building inspector login ID.
-
InspectorName(optional):
string
Title:
Inspector
Maximum Length:360
The name of the inspector. -
InspectorPhone(optional):
string
Title:
Inspector Phone
The building inspector phone number. -
InspectorUserId(optional):
string
Title:
Inspector User ID
The building inspector user ID. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the record was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit ID
Maximum Length:50
The building permit record identifier. For example, a permit ID with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for a permit record.
-
NumberMajorViolations(optional):
integer(int32)
Title:
Major Violation
The total number of major violations for the inspection. -
Owner(optional):
string
Title:
Owner
Maximum Length:150
The primary or only owner of the parcel or property. -
OwnerEmailId(optional):
string
Title:
Owner Email
Maximum Length:50
The parcel owner email address. -
ParcelId(optional):
integer(int64)
Title:
Parcel
The identifier of the record parcel. -
RecordType(optional):
string
Title:
Permit Type
Maximum Length:100
The type of permit on the inspection schedule page, such as a residential addition. -
RecordTypeId(optional):
string
Title:
Record Type ID
Maximum Length:30
The unique alphanumeric code or short name for the record type. -
ScheduledEndDttm(optional):
string(date-time)
Title:
Schedule End Date
The scheduled inspection end date. -
ScheduledStartDttm(optional):
string(date-time)
Title:
Schedule Start Date
The scheduled inspection start date. -
SecondaryOwner(optional):
string
Title:
Secondary Owner
Maximum Length:150
The secondary owner of the parcel or property. -
Url(optional):
string
Title:
URL
The inspection URL used within a communications template. -
UrlLabel(optional):
string
Title:
Communications URL Label
The label displayed for an inspection URL used within a communications template. -
WorkflowAssignedDate(optional):
string
Title:
Workflow Assigned Date
The date when the workflow task was assigned. -
WorkflowDueDate(optional):
string
The workflow task due date.
-
WorkflowEmplId(optional):
string
The employee ID for the workflow task assignee.
-
WorkflowOwnerEmail(optional):
string
Title:
Workflow Assignee Email
The email address for the workflow task assignee. -
WorkflowOwnerLoginId(optional):
string
The login ID for the workflow task assignee.
-
WorkflowOwnerName(optional):
string
Title:
Workflow Assignee
The workflow task assignee name. -
WorkflowOwnerPhone(optional):
string
Title:
Workflow Assignee Phone
The phone number for the workflow task assignee. -
WorkflowOwnerUserId(optional):
string
Title:
Workflow Assignee User ID
The user ID for the workflow task assignee. -
WorkflowTaskId(optional):
string
Title:
Workflow Task ID
The workflow task ID. -
WorkflowTaskName(optional):
string
Title:
Workflow Task Name
The workflow task name.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.