Get an inspection communication item
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCommunications/{publicSectorInspectionCommunicationsUniqID}
Request
Path Parameters
-
publicSectorInspectionCommunicationsUniqID: integer
This is the hash key of the attributes which make up the composite key--- LnpRecordKey and InspectionId ---for the Inspection Communications resource and used to uniquely identify an instance of Inspection Communications. The client should not generate the hash key value. Instead, the client should query on the Inspection Communications collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Communications.
For example: publicSectorInspectionCommunications?q=LnpRecordKey=<value1>;InspectionId=<value2>
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorInspectionCommunications-item
Type:
Show Source
object-
AgencyUser(optional):
string
Title:
Agency UserIndicates whether the inspection was last modified by an agency user. -
Applicant(optional):
integer(int64)
Title:
ApplicantThe party ID of the person applying for the application. -
ApplicantEmailAddress1(optional):
string
Title:
Applicant Email 1Maximum Length:320The permit applicant email address. -
ApplicantEmailAddress2(optional):
string
Title:
Applicant Email 2Maximum Length:320The permit applicant additional email address. -
ApplicantLoginId(optional):
string
The permit applicant login ID.
-
ApplicantPersonName(optional):
string
Title:
Applicant NameMaximum Length:450The permit applicant name. -
ApplicantPersonNameSuffix(optional):
string
Title:
Applicant SuffixMaximum Length:30The suffix to the permit applicant name. -
ApplicantPhoneAreaCode(optional):
string
Title:
Applicant Phone Area CodeMaximum Length:10The area code for the permit applicant phone number. -
ApplicantPhoneCountryCode(optional):
string
Title:
Applicant Phone Country CodeMaximum Length:10The country code for the permit applicant phone number. -
ApplicantPhoneExtension(optional):
string
Title:
Applicant Phone ExtensionMaximum Length:20The permit applicant phone number extension. -
ApplicantPhoneNumber(optional):
string
Title:
Applicant PhoneMaximum Length:40The permit applicant phone number. -
ApplicantUserId(optional):
string
Title:
Applicant User IDThe permit applicant user ID. -
AssessFee(optional):
string
Title:
Assess FeeMaximum Length:1Indicates whether fees should be assessed for the inspection. -
ContactEmail(optional):
string
Title:
Contact EmailMaximum Length:320The email of the contact at the inspection site. -
ContactName(optional):
string
Title:
Location ContactMaximum Length:450The name of the contact at the inspection site. -
EstimatedTimeArrival(optional):
string(date-time)
Title:
Inspection ETA FromThe earliest estimated time of arrival at the building inspection site. -
EstimatedTimeArrivalEnd(optional):
string(date-time)
Title:
Inspection ETA ToThe latest estimated time of arrival at the building inspection site. -
FeeBalanceDue(optional):
number
Title:
Fees Balance DueDisplays the fee balance due for the permit. -
FinalInspection(optional):
string
Title:
Final InspectionMaximum Length:1Indicates whether this is the final inspection. The default is no. -
InspectionAddress1(optional):
string
Title:
Inspection Address Line 1Maximum Length:240The first address line of the building inspection site. -
InspectionAddress2(optional):
string
Title:
Inspection Address Line 2Maximum Length:240The second address line of the building inspection site. -
InspectionCity(optional):
string
Title:
Inspection CityMaximum Length:60The city in the address of the building inspection site. -
InspectionCompleteDttm(optional):
string(date-time)
Title:
Completion DateThe date and time when the inspection was completed. -
InspectionCountry(optional):
string
Title:
Inspection CountryMaximum Length:3The country in the address of the building inspection site. -
InspectionCounty(optional):
string
Title:
Inspection CountyMaximum Length:60The county in the address of the building inspection site. -
InspectionId(optional):
string
Title:
InspectionMaximum Length:50The unique identifier for an inspection. -
InspectionLocation(optional):
string
Title:
Inspection LocationMaximum Length:100The location where the inspection will take place. -
InspectionPostalCode(optional):
string
Title:
Inspection Postal CodeMaximum Length:60The postal code in the address of the building inspection site. -
InspectionProvince(optional):
string
Title:
Inspection ProvinceMaximum Length:60The province in the address of the building inspection site. -
InspectionRating(optional):
string
Title:
RatingMaximum Length:5The overall rating of the inspection, which is calculated based on a defined rating method. -
InspectionResult(optional):
string
Title:
ResultMaximum Length:15The results of the inspection. For example, Pass, Fail, Yes, or No. -
InspectionScore(optional):
integer(int32)
Title:
ScoreThe calculated total score of the inspection. -
InspectionState(optional):
string
Title:
Inspection StateMaximum Length:60The state in the address of the building inspection site. -
InspectionStatus(optional):
string
Title:
Inspection StatusMaximum Length:100The inspection status description. -
InspectionType(optional):
string
Title:
Inspection TypeMaximum Length:100The description of the inspection type. -
InspectorEmail(optional):
string
Title:
Inspector EmailThe building inspector email address. -
InspectorId(optional):
integer(int64)
Title:
Inspector IDThe inspector assigned to the inspection. -
InspectorLoginId(optional):
string
The building inspector login ID.
-
InspectorName(optional):
string
Title:
InspectorMaximum Length:360The name of the inspector. -
InspectorPhone(optional):
string
Title:
Inspector PhoneThe building inspector phone number. -
InspectorUserId(optional):
string
Title:
Inspector User IDThe building inspector user ID. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the record was last updated. -
links(optional):
array Items
Title:
ItemsLink Relations -
LnpRecordId(optional):
string
Title:
Permit IDMaximum Length:50The 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 CountThe total number of major violations for the inspection. -
Owner(optional):
string
Title:
OwnerMaximum Length:150The primary or only owner of the parcel or property. -
OwnerEmailId(optional):
string
Title:
Owner EmailMaximum Length:50The parcel owner email address. -
ParcelId(optional):
integer(int64)
Title:
ParcelThe identifier of the record parcel. -
RecordType(optional):
string
Title:
Permit TypeMaximum Length:100The type of permit on the inspection schedule page, such as a residential addition. -
RecordTypeId(optional):
string
Title:
Record Type IDMaximum Length:30The unique alphanumeric code or short name for the record type. -
ScheduledEndDttm(optional):
string(date-time)
Title:
Schedule End DateThe scheduled inspection end date. -
ScheduledStartDttm(optional):
string(date-time)
Title:
Schedule Start DateThe scheduled inspection start date. -
SecondaryOwner(optional):
string
Title:
Secondary OwnerMaximum Length:150The secondary owner of the parcel or property. -
SystemResult(optional):
string
Title:
System ResultMaximum Length:20The unique alphanumeric code or short name for the inspection result. -
Url(optional):
string
Title:
URLThe inspection URL used within a communications template. -
UrlLabel(optional):
string
Title:
Communications URL LabelThe label displayed for an inspection URL used within a communications template. -
WorkflowAssignedDate(optional):
string
Title:
Workflow Assigned DateThe date when the workflow task was assigned. -
WorkflowDueDate(optional):
string
The workflow task due date.
-
WorkflowTaskId(optional):
string
Title:
Workflow Task IDThe workflow task ID. -
WorkflowTaskName(optional):
string
Title:
Workflow Task NameThe workflow task name.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.