Jump to

• Request
• Response

Update an inspection action is not supported

patch

/fscmRestApi/resources/11.13.18.05/publicSectorUnasgnInspections/{publicSectorUnasgnInspectionsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorUnasgnInspectionsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- InspectionId and AgencyId ---for the Assigned or Unassigned Inspections resource and used to uniquely identify an instance of Assigned or Unassigned Inspections. The client should not generate the hash key value. Instead, the client should query on the Assigned or Unassigned Inspections collection resource with a filter on the primary key values in order to navigate to a specific instance of Assigned or Unassigned Inspections.
  
  For example: publicSectorUnasgnInspections?q=InspectionId=<value1>;AgencyId=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorUnasgnInspections-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  The first line of the address on the inspection.
• Address2(optional): string
  Maximum Length: 240

  The second line of the address on the inspection.
• Address3(optional): string
  Maximum Length: 240

  The third line of the address on the inspection.
• Address4(optional): string
  Maximum Length: 240

  The fourth line of the address on the inspection.
• AgencyId(optional): integer(int64)
  The unique identifier of the agency associated with the inspection.
• City(optional): string
  Maximum Length: 60

  The city of the address on the inspection.
• Country(optional): string
  Maximum Length: 3

  The country of the address on the inspection.
• County(optional): string
  Maximum Length: 60

  The county of the address on the inspection.
• Description(optional): string
  Maximum Length: 100

  The description of the inspection, which comes from the inspection type.
• EstimatedDurationHrs(optional): number
  The estimated duration of the inspection in hours.
• InspectionDistrict(optional): string
  Maximum Length: 50

  The district on the inspection.
• InspectionId(optional): string
  Maximum Length: 50

  The unique identifier of the inspection.
• InspectionType(optional): string
  Maximum Length: 15

  The inspection type on the inspection.
• InspectorId(optional): integer(int64)
  The unique identifier of the inspector assigned to the inspection.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Maximum Length: 50

  The unique identifier of the application record.
• LnpRecordKey(optional): integer(int64)
  The unique identifier of the record associated with the permit.
• PostalCode(optional): string
  Maximum Length: 60

  The postal code of the address on the inspection.
• PreferredDate(optional): string(date-time)
  The preferred date for the inspection to be performed.
• PreferredTime(optional): string
  Maximum Length: 15

  The preferred time for the inspection to be performed.
• ReadyByDttm(optional): string(date-time)
  The date and time after which the inspection can be performed.
• ScheduledEndDttm(optional): string(date-time)
  The date and time that the inspection is scheduled to end.
• ScheduledStartDttm(optional): string(date-time)
  The date and time that the inspection is scheduled to start.
• SchedulingMethod(optional): string
  Maximum Length: 15

  The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
• State(optional): string
  Maximum Length: 60

  The state code of the address on the inspection.
• SystemStatus(optional): string
  Maximum Length: 15

  The code that represents the status of the inspection.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address on the inspection."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address on the inspection."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address on the inspection."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address on the inspection."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the inspection."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the address on the inspection."
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the address on the inspection."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the address on the inspection."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the inspection, which comes from the inspection type."
        },
        "EstimatedDurationHrs":{
            "type":"number",
            "description":"The estimated duration of the inspection in hours."
        },
        "InspectionDistrict":{
            "maxLength":50,
            "type":"string",
            "description":"The district on the inspection."
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the inspection."
        },
        "InspectionType":{
            "maxLength":15,
            "type":"string",
            "description":"The inspection type on the inspection."
        },
        "InspectorId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the inspector assigned to the inspection."
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the application record."
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record associated with the permit."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address on the inspection."
        },
        "PreferredDate":{
            "format":"date-time",
            "type":"string",
            "description":"The preferred date for the inspection to be performed."
        },
        "PreferredTime":{
            "maxLength":15,
            "type":"string",
            "description":"The preferred time for the inspection to be performed."
        },
        "ReadyByDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time after which the inspection can be performed."
        },
        "ScheduledEndDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the inspection is scheduled to end."
        },
        "ScheduledStartDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the inspection is scheduled to start."
        },
        "SchedulingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state code of the address on the inspection."
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The code that represents the status of the inspection."
        },
        "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

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorUnasgnInspections-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  The first line of the address on the inspection.
• Address2(optional): string
  Maximum Length: 240

  The second line of the address on the inspection.
• Address3(optional): string
  Maximum Length: 240

  The third line of the address on the inspection.
• Address4(optional): string
  Maximum Length: 240

  The fourth line of the address on the inspection.
• AgencyId(optional): integer(int64)
  The unique identifier of the agency associated with the inspection.
• City(optional): string
  Maximum Length: 60

  The city of the address on the inspection.
• Country(optional): string
  Maximum Length: 3

  The country of the address on the inspection.
• County(optional): string
  Maximum Length: 60

  The county of the address on the inspection.
• Description(optional): string
  Maximum Length: 100

  The description of the inspection, which comes from the inspection type.
• EstimatedDurationHrs(optional): number
  The estimated duration of the inspection in hours.
• InspectionDistrict(optional): string
  Maximum Length: 50

  The district on the inspection.
• InspectionId(optional): string
  Maximum Length: 50

  The unique identifier of the inspection.
• InspectionType(optional): string
  Maximum Length: 15

  The inspection type on the inspection.
• InspectorId(optional): integer(int64)
  The unique identifier of the inspector assigned to the inspection.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Maximum Length: 50

  The unique identifier of the application record.
• LnpRecordKey(optional): integer(int64)
  The unique identifier of the record associated with the permit.
• PostalCode(optional): string
  Maximum Length: 60

  The postal code of the address on the inspection.
• PreferredDate(optional): string(date-time)
  The preferred date for the inspection to be performed.
• PreferredTime(optional): string
  Maximum Length: 15

  The preferred time for the inspection to be performed.
• ReadyByDttm(optional): string(date-time)
  The date and time after which the inspection can be performed.
• ScheduledEndDttm(optional): string(date-time)
  The date and time that the inspection is scheduled to end.
• ScheduledStartDttm(optional): string(date-time)
  The date and time that the inspection is scheduled to start.
• SchedulingMethod(optional): string
  Maximum Length: 15

  The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
• State(optional): string
  Maximum Length: 60

  The state code of the address on the inspection.
• SystemStatus(optional): string
  Maximum Length: 15

  The code that represents the status of the inspection.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address on the inspection."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address on the inspection."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address on the inspection."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address on the inspection."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the inspection."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the address on the inspection."
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the address on the inspection."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the address on the inspection."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the inspection, which comes from the inspection type."
        },
        "EstimatedDurationHrs":{
            "type":"number",
            "description":"The estimated duration of the inspection in hours."
        },
        "InspectionDistrict":{
            "maxLength":50,
            "type":"string",
            "description":"The district on the inspection."
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the inspection."
        },
        "InspectionType":{
            "maxLength":15,
            "type":"string",
            "description":"The inspection type on the inspection."
        },
        "InspectorId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the inspector assigned to the inspection."
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the application record."
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record associated with the permit."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address on the inspection."
        },
        "PreferredDate":{
            "format":"date-time",
            "type":"string",
            "description":"The preferred date for the inspection to be performed."
        },
        "PreferredTime":{
            "maxLength":15,
            "type":"string",
            "description":"The preferred time for the inspection to be performed."
        },
        "ReadyByDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time after which the inspection can be performed."
        },
        "ScheduledEndDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the inspection is scheduled to end."
        },
        "ScheduledStartDttm":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the inspection is scheduled to start."
        },
        "SchedulingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state code of the address on the inspection."
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The code that represents the status of the inspection."
        },
        "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