Schedule Inspection

Creates an inspection with the specified inspection and scheduling information. The Schedule Inspection API automatically sets the inspection status to "Scheduled" and category to "Insp Scheduled".

Resource Information

Scopeinspections

Deprecated scope name:   schedule_inspection

App TypeAll
Authorization TypeAccess token
URI /v4/inspections/schedule?lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
billablestringNoY | NThis defines whether or not the item is billable.7.3.2
categorystringNo The inspection category, which is used to organize inspection types. An inspection type is assigned to one or more inspection categories.7.3.2
commentDisplaystringNoY | NIndicates whether or not Accela Citizen Access users can view the inspection results comments.7.3.2
commentPublicVisible[]stringNo Specifies the type of user who can view the inspection result comments. "All ACA Users" - Both registered and anonymous Accela Citizen Access users can view the comments for inspection results. "Record Creator Only" - the user who created the record can see the comments for the inspection results. "Record Creator and Licensed Professional" - The user who created the record and the licensed professional associated with the record can see the comments for the inspection results.7.3.2
completedAMPMstringNoAM | PMIndicates whether completed time is "AM" or "PM".7.3.2
completedDatedateTimeNo The date of completion.7.3.2
completedTimestringNo The time of completion.7.3.2
contactcontact{}No The contact information.7.3.2
contact.firstNamestringNo The contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
contact.fullNamestringNo The contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
contact.idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
contact.lastNamestringNo The last name (surname). 7.3.2
contact.middleNamestringNo The middle name. 7.3.2
contact.phone1stringNo The primary telephone number of the contact. 7.3.2
desiredAMPMstringNoAM | PMIndicates whether the desired inspection time is AM or PM.7.3.2
desiredDatedateTimeNo The desired inspection date.7.3.2
desiredTimestringNo The desired inspection time.7.3.2
endMileagefloatNo The ending mileage for the inspection.7.3.2
endTimedateTimeNo The time the inspection was completed.7.3.2
estimatedEndTimestringNo inspection estimated end time.7.3.2
estimatedStartTimestringNo The scheduled start time for the inspection.7.3.2
gisAreaNamestringNo The GIS Object ID of the parent application if the application that the inspection is scheduled for has a parent application that is a project application.7.3.2
gradestringNo Get All Inspection Grades The name of the inspection grade. 7.3.2
inspectorIdstringNo The ID number of the inspector.7.3.2
isAutoAssignstringNoY | NThis defines whether or not you want to automatically reschedule the inspection when the previous inspection status attains Approved status.7.3.2
latitudefloatNo The angular distance of a place north or south of the earth's equator, usually expressed in degrees and minutes.7.3.2
longitudefloatNo The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed in degrees and minutes.7.3.2
majorViolationlongNo The number of major violations.7.3.2
overtimestringNo A labor cost factor that indicates time worked beyond a worker's regular working hours.7.3.2
publicVisiblestringNoY | NIndicates whether or not Accela Citizen Access users can view comment about the inspection results.7.3.2
recordIdrecordId{}No The unique ID associated with a record.7.3.2
recordId.customIdstringNo An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
recordId.idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
recordId.serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
recordId.trackingIdlongNo The application tracking number (IVR tracking number).7.3.2
recordId.valuestringNo The value for the specified parameter.7.3.2
requestCommentstringNo Comments about the new inspection. For example, you may identify who requested the inspection.7.3.2
requestorFirstNamestringNo The first name of the person requesting an inspection-related operation.7.3.2
requestorLastNamestringNo The last name of the person requesting an inspection-related operation.7.3.2
requestorMiddleNamestringNo The middle name of the person requesting an inspection-related operation.7.3.2
requestorPhonestringNo The telephone number for the person who processes the inspection request or schedules the inspection.7.3.2
requestorPhoneIDDstringNo The telephone number for the person who processes the inspection request or schedules the inspection.7.3.2
requestorUserIdstringNo The user Id of the person requesting an inspection-related operation.7.3.2
requiredInspectionstringNoY | NThis defines whether the inspection is optional or required.7.3.2
resultCommentstringNo The inspection result comments.7.3.2
resultTypestringNo The type of result that can be ascibed to an inspection. There are three result types: Approved: Approves (passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist items do not need a status of app7.3.2
scheduleEndAMPMstringNoAM | PMThe date when the inspection gets scheduled.7.3.2
scheduleEndTimestringNo Indicates whether the scheduleEndTime is in the AM or PM. 7.3.2
scheduleStartAMPMstringNoAM | PMThe scheduled end time for the inspection.7.3.2
scheduleStartTimestringNo AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.7.3.2
startMileagefloatNo The scheduled start time for the inspection.7.3.2
startTimedateTimeNo The time when you started the inspection.7.3.2
statusstatus{}No Get All Inspection Statuses The inspection status.7.3.2
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
totalMileagefloatNo The total mileage for the inspection.7.3.2
totalScorelongNo The overall score of the inspection that includes the inspection result, inspection grade, checklist total score and checklist major violation option.7.3.2
totalTimedoubleNo The total amount of time used to do an inspection.7.3.2
typetype{}No Get All Inspection Types Get Inspection Types The inspection type.7.3.2
type.groupstringNo The name of a group of inspection types.7.3.2
type.idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
type.textstringNo The localized display text.7.3.2
type.valuestringNo The value for the specified parameter.7.3.2
unitNumberstringNo The number of time units (see timeUnitDuration) comprising an inspection.7.3.2
unitsdoubleNo The amount of time comprising the smallest time unit for conducting an inspection.7.3.2
vehicleIdstringNo A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.7.3.2
langStringNo Indicates the language applied.7.3.2

Example

Sample Request Head

POST https://apis.accela.com/v4/inspections/schedule

Sample Request Body

{
  "serviceProviderCode": "ISLANDTON",
  "type": {
    "value": "Initial Investigation",
    "id": 173,
    "text": "Initial Investigation"
  },
  "inspectorId": "MINSPECTOR",
  "recordId": {
    "id": "ISLANDTON-12CAP-00000-0000L"
  },
  "status": {
    "value": "Scheduled",
    "text": "Scheduled"
  },
  "requestDate": "2014-10-15",
  "scheduleDate": "2014-12-01"
}

Notes

The following sample request uses the ISLANDTON agency in the TEST environment on the Accela Developer Sandbox. Click the "Send to Hurl.It" link below to submit the sample request. Replace YOUR-ACCESS-TOKEN before submitting the request.

curl
   -H 'Content-type: application/json'
   -H 'Accept: application/json'
   -H 'Authorization: YOUR-ACCESS-TOKEN'
   -X POST https://apis.accela.com/v4/inspections/schedule
   -d {"serviceProviderCode":"ISLANDTON","type":{"value":"Initial%20Investigation","id":"173","text":"Initial%20Investigation"},"inspectorId":"MINSPECTOR","recordId":{"id":"ISLANDTON-12CAP-00000-0000L"},"status":{"value":"Scheduled","text":"Scheduled"},"requestDate":"2014-10-15","scheduleDate":"2014-12-01"}

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.2
result.addressresult.address{}The address of the subject.7.3.2
result.address.addressLine1stringThe first line of the address. 7.3.2
result.address.addressLine2stringThe second line of the address.7.3.2
result.address.addressTypeFlagresult.address.addressTypeFlag{}The current status of the address record.7.3.2
result.address.addressTypeFlag.textstringThe localized display text.7.3.2
result.address.addressTypeFlag.valuestringThe value for the specified parameter.7.3.2
result.address.citystringThe name of the city.7.3.2
result.address.countryresult.address.country{}The name of the country.7.3.2
result.address.country.textstringThe localized display text.7.3.2
result.address.country.valuestringThe value for the specified parameter.7.3.2
result.address.countystringThe name of the county.7.3.2
result.address.descriptionstringThe description of the record or item.7.3.2
result.address.directionresult.address.direction{}The street direction of the primary address associated with the application.7.3.2
result.address.direction.textstringThe localized display text.7.3.2
result.address.direction.valuestringThe value for the specified parameter.7.3.2
result.address.distancedoubleThe distance from another landmark used to locate the address. 7.3.2
result.address.houseAlphaEndstringThe ending street number that makes up the address.7.3.2
result.address.houseAlphaStartstringThe beginning street number that makes up the address.7.3.2
result.address.houseFractionEndresult.address.houseFractionEnd{}Used in combination with the Street # fields.7.3.2
result.address.houseFractionEnd.textstringThe localized display text.7.3.2
result.address.houseFractionEnd.valuestringThe value for the specified parameter.7.3.2
result.address.houseFractionStartresult.address.houseFractionStart{}Used In combination with the Street # fields.7.3.2
result.address.houseFractionStart.textstringThe localized display text.7.3.2
result.address.houseFractionStart.valuestringThe value for the specified parameter.7.3.2
result.address.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.address.inspectionDistrictstringThe inspection district where the address is located.7.3.2
result.address.inspectionDistrictPrefixstringThe prefix for the inspection district where the address is located.7.3.2
result.address.isPrimarystringIndicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.2
result.address.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.2
result.address.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.2
result.address.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.2
result.address.neighborhoodstringThe neighborhood where the address is located.7.3.2
result.address.neighborhoodPrefixstringThe prefix for the neighborhood where the address is located.7.3.2
result.address.postalCodestringThe postal ZIP code for the address.7.3.2
result.address.recordIdresult.address.recordId{}The unique ID associated with a record.7.3.2
result.address.recordId.customIdstringAn ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
result.address.recordId.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.address.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.address.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.address.recordId.valuestringThe value for the specified parameter.7.3.2
result.address.refAddressIdlongThe unique Id generated for an address stored in the system.7.3.2
result.address.secondaryStreetstringThis field (along with the Secondary Road Number field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
result.address.secondaryStreetNumberlongThis field (along with the Secondary Road field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
result.address.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.address.stateresult.address.state{}The state corresponding to the address on record.7.3.2
result.address.state.textstringThe localized display text.7.3.2
result.address.state.valuestringThe value for the specified parameter.7.3.2
result.address.statusresult.address.status{}The address status indicating whether the address is active or inactive.7.3.2
result.address.status.textstringThe localized display text.7.3.2
result.address.status.valuestringThe value for the specified parameter.7.3.2
result.address.streetAddressstringThe street address. 7.3.2
result.address.streetEndlongThe end of a range of street numbers.7.3.2
result.address.streetEndFromlongThe start of the street End range.7.3.2
result.address.streetEndTolongThe last of the street End range.7.3.2
result.address.streetNamestringThe street name for the address.7.3.2
result.address.streetPrefixstringAny part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.7.3.2
result.address.streetStartlongThe start of a range of street numbers.7.3.2
result.address.streetStartFromlongThe first of the street start range.7.3.2
result.address.streetStartTolongThe last of the street start range.7.3.2
result.address.streetSuffixresult.address.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.2
result.address.streetSuffix.textstringThe localized display text.7.3.2
result.address.streetSuffix.valuestringThe value for the specified parameter.7.3.2
result.address.streetSuffixDirectionresult.address.streetSuffixDirection{}The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.7.3.2
result.address.streetSuffixDirection.textstringThe localized display text.7.3.2
result.address.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.2
result.address.typeresult.address.type{}The address type.7.3.2
result.address.type.textstringThe localized display text.7.3.2
result.address.type.valuestringThe value for the specified parameter.7.3.2
result.address.unitEndstringThe end parameter of a range of unit numbers.7.3.2
result.address.unitStartstringThe starting parameter of a range of unit numbers.7.3.2
result.address.unitTyperesult.address.unitType{}The unit type designation of the address.7.3.2
result.address.unitType.textstringThe localized display text.7.3.2
result.address.unitType.valuestringThe value for the specified parameter.7.3.2
result.address.xCoordinatedoubleThe longitudinal coordinate for this address. 7.3.2
result.address.yCoordinatedoubleThe latitudinal coordinate for this address. 7.3.2
result.billablestringThis defines whether or not the item is billable.7.3.2
result.categorystringThe inspection category, which is used to organize inspection types. An inspection type is assigned to one or more inspection categories.7.3.2
result.commentDisplaystringIndicates whether or not Accela Citizen Access users can view the inspection results comments.7.3.2
result.commentPublicVisible[]stringSpecifies the type of user who can view the inspection result comments. "All ACA Users" - Both registered and anonymous Accela Citizen Access users can view the comments for inspection results. "Record Creator Only" - the user who created the record can see the comments for the inspection results. "Record Creator and Licensed Professional" - The user who created the record and the licensed professional associated with the record can see the comments for the inspection results.7.3.2
result.completedAMPMstringIndicates whether completed time is "AM" or "PM".7.3.2
result.completedDatedateTimeThe date of completion.7.3.2
result.completedTimestringThe time of completion.7.3.2
result.contactresult.contact{}The contact information.7.3.2
result.contact.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.contact.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
result.contact.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.contact.lastNamestringThe last name (surname). 7.3.2
result.contact.middleNamestringThe middle name. 7.3.2
result.contact.phone1stringThe primary telephone number of the contact. 7.3.2
result.contactFirstNamestringThe first name of the contact.7.3.2
result.contactLastNamestringThe last name of the contact.7.3.2
result.contactMiddleNamestringThe middle name of the contact.7.3.2
result.desiredAMPMstringIndicates whether the desired inspection time is AM or PM.7.3.2
result.desiredDatedateTimeThe desired inspection date.7.3.2
result.desiredTimestringThe desired inspection time.7.3.2
result.endMileagefloatThe ending mileage for the inspection.7.3.2
result.endTimedateTimeThe time the inspection was completed.7.3.2
result.estimatedEndTimestringinspection estimated end time.7.3.2
result.estimatedStartTimestringThe scheduled start time for the inspection.7.3.2
result.gisAreaNamestringThe GIS Object ID of the parent application if the application that the inspection is scheduled for has a parent application that is a project application.7.3.2
result.gradestringThe name of the inspection grade. 7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.inspectorFullNamestringThe name of the inspector performing the assessment.7.3.2
result.inspectorIdstringThe ID number of the inspector.7.3.2
result.isAutoAssignstringThis defines whether or not you want to automatically reschedule the inspection when the previous inspection status attains Approved status.7.3.2
result.latitudefloatThe angular distance of a place north or south of the earth's equator, usually expressed in degrees and minutes.7.3.2
result.longitudefloatThe angular distance of a place east or west of the meridian at Greenwich, England, usually expressed in degrees and minutes.7.3.2
result.majorViolationlongThe number of major violations.7.3.2
result.overtimestringA labor cost factor that indicates time worked beyond a worker's regular working hours.7.3.2
result.prioritydoubleThe priority level assigned to the inspection.7.3.2
result.publicVisiblestringIndicates whether or not Accela Citizen Access users can view comment about the inspection results.7.3.2
result.recordIdresult.recordId{}The unique ID associated with a record.7.3.2
result.recordId.customIdstringAn ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
result.recordId.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.recordId.valuestringThe value for the specified parameter.7.3.2
result.recordTyperesult.recordType{}The type of application. The available application type options include all the application types that your agency administrator sets as enabled.7.3.2
result.recordType.aliasstringThe record type alias.7.3.2
result.recordType.categorystringThe 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.filterNamestringThe name of the record type filter which defines the record types to be displayed for the citizen user.7.3.2
result.recordType.groupstringThe 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordType.modulestringUse to filter by the module.7.3.2
result.recordType.subTypestringThe 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.textstringThe localized display text.7.3.2
result.recordType.typestringThe 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).7.3.2
result.recordType.valuestringThe value for the specified parameter.7.3.2
result.requestAMPMstringThe time segment, AM or PM, for the time specified in the requestTime field.7.3.2
result.requestCommentstringComments about the new inspection. For example, you may identify who requested the inspection.7.3.2
result.requestDatedateTimeThe date when an inspection request is submitted. 7.3.2
result.requestorFirstNamestringThe first name of the person requesting an inspection-related operation.7.3.2
result.requestorLastNamestringThe last name of the person requesting an inspection-related operation.7.3.2
result.requestorMiddleNamestringThe middle name of the person requesting an inspection-related operation.7.3.2
result.requestorPhonestringThe telephone number for the person who processes the inspection request or schedules the inspection.7.3.2
result.requestorPhoneIDDstringThe telephone number for the person who processes the inspection request or schedules the inspection.7.3.2
result.requestorUserIdstringThe user Id of the person requesting an inspection-related operation.7.3.2
result.requestTimestringThis time is automatically generated when a new inspection is scheduled and submitted.7.3.2
result.requiredInspectionstringThis defines whether the inspection is optional or required.7.3.2
result.resultCommentstringThe inspection result comments.7.3.2
result.resultTypestringThe type of result that can be ascibed to an inspection. There are three result types: Approved: Approves (passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist items do not need a status of app7.3.2
result.scheduleDatedateTimeThe date when the inspection gets scheduled.7.3.2
result.scheduleEndAMPMstringIndicates whether the scheduleEndTime is in the AM or PM. 7.3.2
result.scheduleEndTimestringThe scheduled end time for the inspection.7.3.2
result.scheduleStartAMPMstringAM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.7.3.2
result.scheduleStartTimestringThe scheduled start time for the inspection.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.startMileagefloatThe starting mileage for the inspection.7.3.2
result.startTimedateTimeThe time when you started the inspection.7.3.2
result.statusresult.status{}The inspection status.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.submitAMPMstringThe time block for the scheduled inspection.7.3.2
result.submitDatedateTimeThe date that the inspection was submitted. 7.3.2
result.submitTimestringThe time that a new inspection is submitted. Accela Automation generates this value.7.3.2
result.totalMileagefloatThe total mileage for the inspection.7.3.2
result.totalScorelongThe overall score of the inspection that includes the inspection result, inspection grade, checklist total score and checklist major violation option.7.3.2
result.totalTimedoubleThe total amount of time used to do an inspection.7.3.2
result.typeresult.type{}The inspection type.7.3.2
result.type.groupstringThe name of a group of inspection types.7.3.2
result.type.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
result.unitNumberstringThe number of time units (see timeUnitDuration) comprising an inspection.7.3.2
result.unitsdoubleThe amount of time comprising the smallest time unit for conducting an inspection.7.3.2
result.vehicleIdstringA number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "address": {
      "id": 1000183970,
      "city": "San Francisco",
      "postalCode": "94102",
      "serviceProviderCode": "ISLANDTON",
      "streetName": "301 Powell St",
      "state": {
        "value": "CA",
        "text": "CA"
      }
    },
    "id": 6389954,
    "priority": 0,
    "serviceProviderCode": "ISLANDTON",
    "type": {
      "value": "Initial Investigation",
      "id": 173,
      "group": "SR_GENERAL",
      "text": "Initial Investigation"
    },
    "inspectorId": "MINSPECTOR",
    "recordId": {
      "id": "ISLANDTON-12CAP-00000-0000L",
      "customId": "SR-2012-00017",
      "serviceProviderCode": "ISLANDTON",
      "trackingId": 217351082,
      "value": "12CAP-00000-0000L"
    },
    "inspectorFullName": "Mobile Inspector",
    "category": "Insp Scheduled",
    "requestorFirstName": "App",
    "requestorMiddleName": "",
    "requestorLastName": "Developer",
    "requiredInspection": "N",
    "publicVisible": "Y",
    "status": {
      "value": "Scheduled",
      "text": "Scheduled"
    },
    "isAutoAssign": "N",
    "requestDate": "2014-10-15",
    "scheduleDate": "2014-12-01"
  }
}