Jump to

• Request
• Response

Get all IVR inspections

get

/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections

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:
  
  

  • RowFinder: Finds an IVR inspection by INSPECTION_ID and LNP_RECORD_ID. Finder Variables:
    • LNP_RECORD_ID; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
  • PrimaryKey: Finds the IVR inspection that matches the specified primary key criteria. Finder Variables:
    • InspectionKey; integer; The unique identifier for the IVR inspection.
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorIVRInspections

Type: object

Show Source

• 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.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorIVRInspections-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorIVRInspections-item

{
    "items":{
        "$ref":"#/definitions/publicSectorIVRInspections-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorIVRInspections-item

Type: object

Show Source

• ActlTravelTimeFromHrs(optional): number
  Title: Travel Time from Site

  The travel time from the inspection site in hours.
• ActlTravelTimeToHrs(optional): number
  Title: Travel Time to Site

  The travel time to the inspection site in hours.
• ActualDurationHrs(optional): number
  Title: Duration in Hours

  The actual duration of the inspection in hours.
• ActualEndDttm(optional): string(date-time)
  Title: End Date

  The actual end date of the inspection.
• ActualStartDttm(optional): string(date-time)
  Title: Start Date

  The actual start date of the inspection.
• AddressId(optional): integer(int64)
  The unique identifier of the record parcel address.
• AgencyId(optional): integer(int64)
  Title: Agency ID

  The identifier for the public sector agency associated with the inspection.
• BillableFlag(optional): boolean
  Title: Billable Option

  Indicates whether the inspection is billable. The value defaults from the inspection type associated with the inspection.
• BillType(optional): string
  Title: Billable Type

  Maximum Length: 15

  The bill type that determines the invoice type generated for this inspection.
• CancellationReason(optional): string
  Title: Cancellation Reason

  Maximum Length: 150

  The reason for canceling the inspection.
• ContractorSignatureDttm(optional): string(date-time)
  Title: Signed

  The date and time when the contractor signed the inspection.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the record was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the inspection transaction.
• DistanceUOM(optional): string
  Title: Units

  Maximum Length: 5

  The distance unit of measure. The prompt is the common units table.
• EstimatedDurationHrs(optional): number
  Title: Estimated Duration in Hours

  The estimated duration of the inspection in hours.
• EstimatedTimeArrival(optional): string(date-time)
  Title: ETA From

  The estimated time of arrival at the inspection site.
• EstimatedTimeArrivalEnd(optional): string(date-time)
  Title: ETA To

  The estimated end time of arrival at the inspection site.
• FinalInspectionFlag(optional): boolean
  Indicates whether this is the final inspection. The default is no.
• HideInspectorComment(optional): string
  Title: Hide Inspector Comment

  Maximum Length: 1

  Indicates whether the inspector's comments are hidden from public users. This value defaults from the inspection type.
• InspectionCompleteDttm(optional): string(date-time)
  Title: Completion Date

  The date and time when the inspection was completed.
• InspectionDistrictId(optional): string
  Title: District

  Maximum Length: 30

  The unique identifier for the inspection district.
• InspectionId(optional): string
  Title: Inspection

  Maximum Length: 50

  The unique identifier for an inspection. Identifies the inspection transaction on the inspection list page and generated based on the automatic number rule configured for this inspection type, for example, E2018-00006.
• InspectionKey(optional): integer(int64)
  The unique identifier of an inspection.
• InspectionLocation(optional): string
  Title: Inspection Location

  Maximum Length: 100

  An optional descriptive name of the inspection location, such as Bank of America Building or corner lot.
• InspectionName(optional): string
  Maximum Length: 100

  The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.
• InspectionRating(optional): string
  Title: Rating

  Maximum Length: 5

  The calculated rating based on the rating method.
• InspectionResult(optional): string
  Title: Result

  Maximum Length: 15

  The result of inspection, such as Pass, Fail, Yes, and No.
• InspectionScore(optional): integer(int32)
  Title: Score

  The calculated total inspection score.
• InspectionStatus(optional): string
  Title: Status

  Maximum Length: 15

  The status of the inspection.
• InspectionType(optional): string
  Title: Inspection Type

  Maximum Length: 15

  The type of the inspection, such as Electrical.
• InspectorSignatureDttm(optional): string(date-time)
  Title: Signed

  The date and time when the inspector signed the inspection.
• IvrAccessCode(optional): string
  The IVR password associated with the permit's applicant user profile, or the user profile of any of the permit's registered contacts.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date the inspection was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
• LnpRecordKey(optional): integer(int64)
  Title: Record

  The unique identifier for a record.
• NoneResultItemCount(optional): number
  The number of checklist items for the inspection for which there is no inspection result.
• NumberMajorViolations(optional): integer(int32)
  Title: Major Violation

  The calculated total number of major violations for the inspection.
• OwnerSignatureDttm(optional): string(date-time)
  Title: Signed On

  The date and time when the owner signed the inspection.
• ParcelId(optional): integer(int64)
  The unique identifier of the record parcel.
• PreferredDate(optional): string(date-time)
  Title: Preferred Date

  The preferred date for the inspection.
• PreferredTime(optional): string
  Title: Preferred Time

  Maximum Length: 15

  The preferred time for the inspection, for example Morning or Afternoon.
• ReadyByDttm(optional): string(date-time)
  Title: Ready By

  The date and time that the inspection site will be ready for the inspection to be performed.
• RecordType(optional): string
  Title: Permit Type

  Maximum Length: 100

  The user-friendly name for the permit type.
• ReinspectionFlag(optional): boolean
  Indicates whether this is a reinspection. The default is no.
• RequestedDate(optional): string
  Title: Ready by Date

  Maximum Length: 255

  The date when the inspection was requested.
• RequestedTime(optional): string
  Title: Ready by Time

  Maximum Length: 255

  The time when the inspection was requested.
• RequestorComment(optional): string
  Title: Comments

  Maximum Length: 500

  The inspection requester's comments.
• ScheduledEndDttm(optional): string(date-time)
  Title: Schedule End Date

  The scheduled inspection end date.
• ScheduledStartDate(optional): string
  Title: Date

  Maximum Length: 255

  The date when the inspection was scheduled.
• ScheduledStartDttm(optional): string(date-time)
  Title: Schedule Start Date

  The scheduled inspection start date.
• ScheduledStartTime(optional): string
  Title: Time

  Maximum Length: 255

  The time when the inspection was scheduled.
• StatusTime(optional): string(date-time)
  The date and time value of the scheduled inspection start time, requested inspection start time, or last updated date, which is determined by the inspection status.
• StreetNumber(optional): string
  Maximum Length: 20

  The street number of the parcel address, or the first four characters of the parcel address.
• SystemResult(optional): string
  Maximum Length: 20

  The unique alphanumeric code or short name for the inspection result.
• SystemStatus(optional): string
  Maximum Length: 15

  The unique alphanumeric code or short name for the inspection status.
• TravelFromActualDistance(optional): number
  The total distance traveled from the inspection site.
• TravelFromEndOdometer(optional): number
  The odometer reading upon arrival at the next location.
• TravelFromStartOdometer(optional): number
  The odometer reading before travel from the inspection site.
• TravelToActualDistance(optional): number
  The total distance traveled to the inspection site.
• TravelToEndOdometer(optional): number
  The odometer reading upon arrival at the site.
• TravelToStartOdometer(optional): number
  The odometer reading before travel to the inspection site.

{
    "properties":{
        "ActlTravelTimeFromHrs":{
            "type":"number",
            "description":"The travel time from the inspection site in hours.",
            "title":"Travel Time from Site"
        },
        "ActlTravelTimeToHrs":{
            "type":"number",
            "description":"The travel time to the inspection site in hours.",
            "title":"Travel Time to Site"
        },
        "ActualDurationHrs":{
            "type":"number",
            "description":"The actual duration of the inspection in hours.",
            "title":"Duration in Hours"
        },
        "ActualEndDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The actual end date of the inspection.",
            "title":"End Date"
        },
        "ActualStartDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The actual start date of the inspection.",
            "title":"Start Date"
        },
        "AddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record parcel address."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection.",
            "title":"Agency ID"
        },
        "BillType":{
            "maxLength":15,
            "type":"string",
            "description":"The bill type that determines the invoice type generated for this inspection.",
            "title":"Billable Type"
        },
        "BillableFlag":{
            "type":"boolean",
            "description":"Indicates whether the inspection is billable. The value defaults from the inspection type associated with the inspection.",
            "title":"Billable Option"
        },
        "CancellationReason":{
            "maxLength":150,
            "type":"string",
            "description":"The reason for canceling the inspection.",
            "title":"Cancellation Reason"
        },
        "ContractorSignatureDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the contractor signed the inspection.",
            "title":"Signed"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the inspection transaction.",
            "title":"Description"
        },
        "DistanceUOM":{
            "maxLength":5,
            "type":"string",
            "description":"The distance unit of measure. The prompt is the common units table.",
            "title":"Units"
        },
        "EstimatedDurationHrs":{
            "type":"number",
            "description":"The estimated duration of the inspection in hours.",
            "title":"Estimated Duration in Hours"
        },
        "EstimatedTimeArrival":{
            "format":"date-time",
            "type":"string",
            "description":"The estimated time of arrival at the inspection site.",
            "title":"ETA From"
        },
        "EstimatedTimeArrivalEnd":{
            "format":"date-time",
            "type":"string",
            "description":"The estimated end time of arrival at the inspection site.",
            "title":"ETA To"
        },
        "FinalInspectionFlag":{
            "type":"boolean",
            "description":"Indicates whether this is the final inspection. The default is no."
        },
        "HideInspectorComment":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the inspector's comments are hidden from public users. This value defaults from the inspection type.",
            "title":"Hide Inspector Comment"
        },
        "InspectionCompleteDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the inspection was completed.",
            "title":"Completion Date"
        },
        "InspectionDistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the inspection district.",
            "title":"District"
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for an inspection. Identifies the inspection transaction on the inspection list page and generated based on the automatic number rule configured for this inspection type, for example, E2018-00006.",
            "title":"Inspection"
        },
        "InspectionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of an inspection."
        },
        "InspectionLocation":{
            "maxLength":100,
            "type":"string",
            "description":"An optional descriptive name of the inspection location, such as Bank of America Building or corner lot.",
            "title":"Inspection Location"
        },
        "InspectionName":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection."
        },
        "InspectionRating":{
            "maxLength":5,
            "type":"string",
            "description":"The calculated rating based on the rating method.",
            "title":"Rating"
        },
        "InspectionResult":{
            "maxLength":15,
            "type":"string",
            "description":"The result of inspection, such as Pass, Fail, Yes, and No.",
            "title":"Result"
        },
        "InspectionScore":{
            "format":"int32",
            "type":"integer",
            "description":"The calculated total inspection score.",
            "title":"Score"
        },
        "InspectionStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the inspection.",
            "title":"Status"
        },
        "InspectionType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of the inspection, such as Electrical.",
            "title":"Inspection Type"
        },
        "InspectorSignatureDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the inspector signed the inspection.",
            "title":"Signed"
        },
        "IvrAccessCode":{
            "type":"string",
            "description":"The IVR password associated with the permit's applicant user profile, or the user profile of any of the permit's registered contacts."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the inspection was last updated.",
            "title":"Last Updated Date"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a record.",
            "title":"Record"
        },
        "NoneResultItemCount":{
            "type":"number",
            "description":"The number of checklist items for the inspection for which there is no inspection result."
        },
        "NumberMajorViolations":{
            "format":"int32",
            "type":"integer",
            "description":"The calculated total number of major violations for the inspection.",
            "title":"Major Violation"
        },
        "OwnerSignatureDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the owner signed the inspection.",
            "title":"Signed On"
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record parcel."
        },
        "PreferredDate":{
            "format":"date-time",
            "type":"string",
            "description":"The preferred date for the inspection.",
            "title":"Preferred Date"
        },
        "PreferredTime":{
            "maxLength":15,
            "type":"string",
            "description":"The preferred time for the inspection, for example Morning or Afternoon.",
            "title":"Preferred Time"
        },
        "ReadyByDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the inspection site will be ready for the inspection to be performed.",
            "title":"Ready By"
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The user-friendly name for the permit type.",
            "title":"Permit Type"
        },
        "ReinspectionFlag":{
            "type":"boolean",
            "description":"Indicates whether this is a reinspection. The default is no."
        },
        "RequestedDate":{
            "maxLength":255,
            "type":"string",
            "description":"The date when the inspection was requested.",
            "title":"Ready by Date"
        },
        "RequestedTime":{
            "maxLength":255,
            "type":"string",
            "description":"The time when the inspection was requested.",
            "title":"Ready by Time"
        },
        "RequestorComment":{
            "maxLength":500,
            "type":"string",
            "description":"The inspection requester's comments.",
            "title":"Comments"
        },
        "ScheduledEndDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The scheduled inspection end date.",
            "title":"Schedule End Date"
        },
        "ScheduledStartDate":{
            "maxLength":255,
            "type":"string",
            "description":"The date when the inspection was scheduled.",
            "title":"Date"
        },
        "ScheduledStartDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The scheduled inspection start date.",
            "title":"Schedule Start Date"
        },
        "ScheduledStartTime":{
            "maxLength":255,
            "type":"string",
            "description":"The time when the inspection was scheduled.",
            "title":"Time"
        },
        "StatusTime":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time value of the scheduled inspection start time, requested inspection start time, or last updated date, which is determined by the inspection status."
        },
        "StreetNumber":{
            "maxLength":20,
            "type":"string",
            "description":"The street number of the parcel address, or the first four characters of the parcel address."
        },
        "SystemResult":{
            "maxLength":20,
            "type":"string",
            "description":"The unique alphanumeric code or short name for the inspection result."
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The unique alphanumeric code or short name for the inspection status."
        },
        "TravelFromActualDistance":{
            "type":"number",
            "description":"The total distance traveled from the inspection site."
        },
        "TravelFromEndOdometer":{
            "type":"number",
            "description":"The odometer reading upon arrival at the next location."
        },
        "TravelFromStartOdometer":{
            "type":"number",
            "description":"The odometer reading before travel from the inspection site."
        },
        "TravelToActualDistance":{
            "type":"number",
            "description":"The total distance traveled to the inspection site."
        },
        "TravelToEndOdometer":{
            "type":"number",
            "description":"The odometer reading upon arrival at the site."
        },
        "TravelToStartOdometer":{
            "type":"number",
            "description":"The odometer reading before travel to the inspection site."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top