API Version AA requirements:
- v3 is supported back to 7.0.5
- v3p requires AA version 7.2 FP2 hotfix 19 or higher
- v4 requires AA version 7.3 FP2 or higher
###Search record by ASI
HTTP Method: POST
URL (v3p): https://apis.accela.com/v3p/search/records/ (Documentation)
URL (v4): https://apis.accela.com/v4/search/records (Documentation)
Sample Request:
{
"asi": {
"Existing Use": "1 & 2 Family Residence"
}
}Sample Response:
{
"status": 200,
"page": {
"offset": 0,
"limit": 25,
"hasmore": true
},
"result": [
{
"serviceProviderCode": "ISLANDTON",
"id": "ISLANDTON-14CAP-00000-000CJ",
"customId": "BLD14-00179",
"trackingId": 277944701,
"name": "D-I Builders Development Model Home",
"module": "Building",
"type": {
"group": "Building",
"type": "Residential",
"subType": "New",
"category": "NA",
"value": "Building/Residential/New/NA",
"id": "Building-Residential-New-NA",
"text": "Residential New",
"module": "Building",
"display": "Residential New"
},
"openedDate": "2014-08-20T07:00:00Z",
"reportedDate": "2014-08-20T18:01:55Z",
"isPublicOwned": false,
"reportedChannel": {
"value": "Call Center",
"text": "Call Center"
},
"status": {
"value": "Submitted",
"text": "Submitted"
},
"statusDate": "2014-08-20T18:01:55Z",
"createdBy": "DI",
"totalJobCost": 0,
"undistributedCost": 0,
"totalFee": 0,
"totalPay": 0,
"balance": 0,
"estimatedProductionUnit": 0,
"actualProductionUnit": 0,
"isBooking": false,
"isInfraction": false,
"isMisdemeanor": false,
"isOffenseWitnessed": false,
"isDefendantSignature": false,
"initiatedProduct": "AV360",
"createdByCloning": "Y"
}
]
}###Search record by ASI
HTTP Method: POST
URL (v3p): https://apis.accela.com/v3p/search/records/ (Documentation)
URL (v4): https://apis.accela.com/v4/search/records (Documentation)
Sample Request:
{
"asit": {
"Plan Type": "Architectural"
}
}Sample Response:
{
"status": 200,
"page": {
"offset": 0,
"limit": 25,
"hasmore": false
},
"result": [
{
"serviceProviderCode": "ISLANDTON",
"id": "ISLANDTON-14CAP-00000-000B7",
"customId": "BLD14-00149",
"trackingId": 257669557,
"name": "BRAD-VuSpex Residential #1",
"module": "Building",
"type": {
"group": "Building",
"type": "Residential",
"subType": "New",
"category": "NA",
"value": "Building/Residential/New/NA",
"id": "Building-Residential-New-NA",
"text": "Residential New",
"module": "Building",
"display": "Residential New"
},
"openedDate": "2014-08-01T07:00:00Z",
"reportedDate": "2014-08-01T07:00:00Z",
"description": "Test permit assigned to Brad the Contractor for VuSpex testing and demo use.",
"isPublicOwned": false,
"assignedToDepartment": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
"assignedToStaff": "BRADP",
"reportedChannel": {
"value": "Call Center",
"text": "Call Center"
},
"status": {
"value": "Submitted",
"text": "Submitted"
},
"statusDate": "2014-08-01T17:36:27Z",
"createdBy": "BRADP",
"recordClass": "COMPLETE",
"totalJobCost": 0,
"undistributedCost": 0,
"totalFee": 20,
"totalPay": 0,
"balance": 20,
"estimatedProductionUnit": 0,
"actualProductionUnit": 0,
"isBooking": false,
"isInfraction": false,
"isMisdemeanor": false,
"isOffenseWitnessed": false,
"isDefendantSignature": false,
"initiatedProduct": "AV360"
}
]
}###Create/Update record ASI in version 3
HTTP Method: PUT
URL: https://apis.accela.com/v3/records/{id} Example: https://apis.accela.com/v3/records/14CAP-00000-000B7
Sample Request - easiest way do this would be to do a GET of https://apis.accela.com/v3/records/14CAP-00000-000B7/asis to get the current ASI fields and values, you'll you the format of this response and drop it into the update record request below. Basically the ASIs array is the output form the Get Record ASI. From here you can edit the value property of any of the fields in the items array.
{
"updateRecord": {
"ASIs": [
{
"id": "BLD_RES",
"display": "BLD_RES",
"subGroups": [
{
"id": "GENERAL",
"display": "GENERAL",
"items": [
{
"value": "Adult Living Facility",
"id": "Existing.cUse",
"display": "Existing Use",
"name": "Existing Use",
"type": "Enumeration",
"enumerations": [
{
"id": "1 & 2 Family Residence",
"display": "1 & 2 Family Residence"
},
{
"id": "Adult Living Facility",
"display": "Adult Living Facility"
},
{
"id": "Apartment",
"display": "Apartment"
},
{
"id": "Auto Parking Structure/Lot",
"display": "Auto Parking Structure/Lot"
},
{
"id": "Church",
"display": "Church"
},
{
"id": "Condominium",
"display": "Condominium"
},
{
"id": "Construction Trailer",
"display": "Construction Trailer"
},
{
"id": "Convalescent Hospital",
"display": "Convalescent Hospital"
},
{
"id": "Educational",
"display": "Educational"
},
{
"id": "Factory-Industrial",
"display": "Factory-Industrial"
},
{
"id": "Hazardous",
"display": "Hazardous"
},
{
"id": "Hospital",
"display": "Hospital"
},
{
"id": "Hotel",
"display": "Hotel"
},
{
"id": "Mobile Home",
"display": "Mobile Home"
},
{
"id": "Office",
"display": "Office"
},
{
"id": "Private Garage",
"display": "Private Garage"
},
{
"id": "Repair Garage",
"display": "Repair Garage"
},
{
"id": "Restaurant",
"display": "Restaurant"
},
{
"id": "Retail",
"display": "Retail"
},
{
"id": "Service Station",
"display": "Service Station"
},
{
"id": "Shell Industrial",
"display": "Shell Industrial"
},
{
"id": "Shell Office",
"display": "Shell Office"
},
{
"id": "Shell Retail",
"display": "Shell Retail"
},
{
"id": "Shell Warehouse",
"display": "Shell Warehouse"
},
{
"id": "Theater",
"display": "Theater"
},
{
"id": "Transit/Bus Shelter",
"display": "Transit/Bus Shelter"
},
{
"id": "Vacant Property",
"display": "Vacant Property"
},
{
"id": "Vehicle Sales & Display",
"display": "Vehicle Sales & Display"
},
{
"id": "Vehicle Service",
"display": "Vehicle Service"
},
{
"id": "Warehouse",
"display": "Warehouse"
}
],
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Proposed.cUse",
"display": "Proposed Use",
"name": "Proposed Use",
"type": "Enumeration",
"enumerations": [
{
"id": "1 & 2 Family Residence",
"display": "1 & 2 Family Residence"
},
{
"id": "Adult Living Facility",
"display": "Adult Living Facility"
},
{
"id": "Apartment",
"display": "Apartment"
},
{
"id": "Auto Parking Structure/Lot",
"display": "Auto Parking Structure/Lot"
},
{
"id": "Church",
"display": "Church"
},
{
"id": "Condominium",
"display": "Condominium"
},
{
"id": "Construction Trailer",
"display": "Construction Trailer"
},
{
"id": "Convalescent Hospital",
"display": "Convalescent Hospital"
},
{
"id": "Educational",
"display": "Educational"
},
{
"id": "Factory-Industrial",
"display": "Factory-Industrial"
},
{
"id": "Hazardous",
"display": "Hazardous"
},
{
"id": "Hospital",
"display": "Hospital"
},
{
"id": "Hotel",
"display": "Hotel"
},
{
"id": "Mobile Home",
"display": "Mobile Home"
},
{
"id": "Office",
"display": "Office"
},
{
"id": "Private Garage",
"display": "Private Garage"
},
{
"id": "Repair Garage",
"display": "Repair Garage"
},
{
"id": "Restaurant",
"display": "Restaurant"
},
{
"id": "Retail",
"display": "Retail"
},
{
"id": "Service Station",
"display": "Service Station"
},
{
"id": "Shell Industrial",
"display": "Shell Industrial"
},
{
"id": "Shell Office",
"display": "Shell Office"
},
{
"id": "Shell Retail",
"display": "Shell Retail"
},
{
"id": "Shell Warehouse",
"display": "Shell Warehouse"
},
{
"id": "Theater",
"display": "Theater"
},
{
"id": "Transit/Bus Shelter",
"display": "Transit/Bus Shelter"
},
{
"id": "Vacant Property",
"display": "Vacant Property"
},
{
"id": "Vehicle Sales & Display",
"display": "Vehicle Sales & Display"
},
{
"id": "Vehicle Service",
"display": "Vehicle Service"
},
{
"id": "Warehouse",
"display": "Warehouse"
}
],
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Ground.cFloor.cArea",
"display": "Ground Floor Area",
"name": "Ground Floor Area",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Total.cFloor.cArea",
"display": "Total Floor Area",
"name": "Total Floor Area",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Number.cof.cStories",
"display": "Number of Stories",
"name": "Number of Stories",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Building.cHeight",
"display": "Building Height",
"name": "Building Height",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Occupancy.cClassification",
"display": "Occupancy Classification",
"name": "Occupancy Classification",
"type": "Enumeration",
"enumerations": [
{
"id": "R-1 Hotel/Motel/Boarding House/Transient",
"display": "R-1 Hotel/Motel/Boarding House/Transient"
},
{
"id": "R-2 Apartment/Non-Transient Hotel/Convent/Fraternity",
"display": "R-2 Apartment/Non-Transient Hotel/Convent/Fraternity"
},
{
"id": "R-3 Single Family/Duplex Residence/Child Care 5 or Less/Congregate Living 15 or Less",
"display": "R-3 Single Family/Duplex Residence/Child Care 5 or Less/Congregate Living 15 or Less"
},
{
"id": "R-4 Residential Assisted Living (5-15)",
"display": "R-4 Residential Assisted Living (5-15)"
},
{
"id": "A-1 Theaters/Concert Halls",
"display": "A-1 Theaters/Concert Halls"
},
{
"id": "A-2 Nightclub/Restaurant/Bar/Banquet Hall",
"display": "A-2 Nightclub/Restaurant/Bar/Banquet Hall"
},
{
"id": "A-3 Amusement/Church/Gym/Library/Museum",
"display": "A-3 Amusement/Church/Gym/Library/Museum"
},
{
"id": "A-4 Arena/Spectator Seating",
"display": "A-4 Arena/Spectator Seating"
},
{
"id": "A-5 Amusement Park/Bleachers/Stadium/Grandstand",
"display": "A-5 Amusement Park/Bleachers/Stadium/Grandstand"
},
{
"id": "B Business",
"display": "B Business"
},
{
"id": "E Educational School to 12th Grade/ Child Care (More than 5)",
"display": "E Educational School to 12th Grade/ Child Care (More than 5)"
},
{
"id": "F-1 Factory Moderate Hazard",
"display": "F-1 Factory Moderate Hazard"
},
{
"id": "F-2 Factory Low Hazard",
"display": "F-2 Factory Low Hazard"
},
{
"id": "H-1 Hazard Detonation",
"display": "H-1 Hazard Detonation"
},
{
"id": "H-2 Hazard Air-Born Deflagration",
"display": "H-2 Hazard Air-Born Deflagration"
},
{
"id": "H-3 Hazard Flamable/Combustible",
"display": "H-3 Hazard Flamable/Combustible"
},
{
"id": "H-4 Hazard Health",
"display": "H-4 Hazard Health"
},
{
"id": "H-5 Hazard Semi-Conductors",
"display": "H-5 Hazard Semi-Conductors"
},
{
"id": "I-1 Institutional Rehab/Assisted Living/Group Home",
"display": "I-1 Institutional Rehab/Assisted Living/Group Home"
},
{
"id": "I-2 Institutional Hospital/Nursing Home",
"display": "I-2 Institutional Hospital/Nursing Home"
},
{
"id": "I-3 Institutional Prisons/Dentention",
"display": "I-3 Institutional Prisons/Dentention"
},
{
"id": "I-4 Institutional Day Care (More than 5)",
"display": "I-4 Institutional Day Care (More than 5)"
},
{
"id": "M Mercantile",
"display": "M Mercantile"
},
{
"id": "S-2 Light Hazard Storage",
"display": "S-2 Light Hazard Storage"
},
{
"id": "S-1 Moderate Hazard Storage",
"display": "S-1 Moderate Hazard Storage"
},
{
"id": "U Utility Agriculture/Accessory/Fence/Tower",
"display": "U Utility Agriculture/Accessory/Fence/Tower"
},
{
"id": "Mixed Occupancy",
"display": "Mixed Occupancy"
}
],
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Occupant.cLoad",
"display": "Occupant Load",
"name": "Occupant Load",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Type.cof.cConstruction",
"display": "Type of Construction",
"name": "Type of Construction",
"type": "Enumeration",
"enumerations": [
{
"id": "I Non-Combustible",
"display": "I Non-Combustible"
},
{
"id": "IA Non-Combustible (3 HR)",
"display": "IA Non-Combustible (3 HR)"
},
{
"id": "IB Non-Combustible (2 HR)",
"display": "IB Non-Combustible (2 HR)"
},
{
"id": "II Non-Combustible",
"display": "II Non-Combustible"
},
{
"id": "IIA Non-Combustible (1 HR)",
"display": "IIA Non-Combustible (1 HR)"
},
{
"id": "IIB Non-Combustible (0 HR)",
"display": "IIB Non-Combustible (0 HR)"
},
{
"id": "III Heavy Timber",
"display": "III Heavy Timber"
},
{
"id": "IIIA Mixed (1 HR)",
"display": "IIIA Mixed (1 HR)"
},
{
"id": "IIIB Mixed (0 HR)",
"display": "IIIB Mixed (0 HR)"
},
{
"id": "IV Heavy Timber",
"display": "IV Heavy Timber"
},
{
"id": "IV-P Non-Combustible (1 HR)",
"display": "IV-P Non-Combustible (1 HR)"
},
{
"id": "IV-U Non-Combustible",
"display": "IV-U Non-Combustible"
},
{
"id": "V-P Combust & Wood (1 HR)",
"display": "V-P Combust & Wood (1 HR)"
},
{
"id": "V-U Combust & Wood",
"display": "V-U Combust & Wood"
},
{
"id": "VI-P Wood (1 HR)",
"display": "VI-P Wood (1 HR)"
},
{
"id": "VI-U Wood",
"display": "VI-U Wood"
},
{
"id": "VA Any Material (1 HR)",
"display": "VA Any Material (1 HR)"
},
{
"id": "VB Any Material (0 HR)",
"display": "VB Any Material (0 HR)"
},
{
"id": "Unknown",
"display": "Unknown"
},
{
"id": "Not Applicable",
"display": "Not Applicable"
}
],
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Fire.cSprinkler",
"display": "Fire Sprinkler",
"name": "Fire Sprinkler",
"type": "YesNo",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Fire.cSprinkler.cType",
"display": "Fire Sprinkler Type",
"name": "Fire Sprinkler Type",
"type": "Enumeration",
"enumerations": [
{
"id": "FM200",
"display": "FM200"
},
{
"id": "NFPA13",
"display": "NFPA13"
},
{
"id": "NFPA13D",
"display": "NFPA13D"
},
{
"id": "NFPA13R",
"display": "NFPA13R"
}
],
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Water.cMeter.cSize",
"display": "Water Meter Size",
"name": "Water Meter Size",
"type": "Enumeration",
"enumerations": [
{
"id": "5/8 in",
"display": "5/8 in"
},
{
"id": "1 in",
"display": "1 in"
},
{
"id": "1 1/2 in",
"display": "1 1/2 in"
},
{
"id": "2 in",
"display": "2 in"
},
{
"id": "3 in Compound",
"display": "3 in Compound"
},
{
"id": "4 in Compound",
"display": "4 in Compound"
},
{
"id": "6 in Compound",
"display": "6 in Compound"
},
{
"id": "3 in Turbo",
"display": "3 in Turbo"
},
{
"id": "4 in Turbo",
"display": "4 in Turbo"
},
{
"id": "6 in Turbo",
"display": "6 in Turbo"
},
{
"id": "Not Applicable",
"display": "Not Applicable"
}
],
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Irrigation.cMeter.cSize",
"display": "Irrigation Meter Size",
"name": "Irrigation Meter Size",
"type": "Enumeration",
"enumerations": [
{
"id": "Irrigation - 5/8 in",
"display": "Irrigation - 5/8 in"
},
{
"id": "Irrigation - 1 in",
"display": "Irrigation - 1 in"
},
{
"id": "Irrigation - 1-1/2 in",
"display": "Irrigation - 1-1/2 in"
},
{
"id": "Irrigation - 2 in",
"display": "Irrigation - 2 in"
},
{
"id": "2 - 1 in Mani",
"display": "2 - 1 in Mani"
},
{
"id": "2 - 2 in Mani",
"display": "2 - 2 in Mani"
},
{
"id": "3 in Compound",
"display": "3 in Compound"
},
{
"id": "4 in Compound",
"display": "4 in Compound"
},
{
"id": "6 in Compound",
"display": "6 in Compound"
},
{
"id": "3 in Turbo",
"display": "3 in Turbo"
},
{
"id": "Existing",
"display": "Existing"
},
{
"id": "Not Applicable",
"display": "Not Applicable"
}
],
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Backflow.cDevice",
"display": "Backflow Device",
"name": "Backflow Device",
"type": "Enumeration",
"enumerations": [
{
"id": "Double Check Valve",
"display": "Double Check Valve"
},
{
"id": "Double Detector Check",
"display": "Double Detector Check"
},
{
"id": "Existing",
"display": "Existing"
},
{
"id": "Not Applicable",
"display": "Not Applicable"
},
{
"id": "Reduced Pressure",
"display": "Reduced Pressure"
},
{
"id": "Unknown",
"display": "Unknown"
}
],
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
}
],
"security": "F",
"entityState": "Unchanged"
},
{
"id": "SITE",
"display": "SITE",
"items": [
{
"value": "",
"id": "Total.cAcreage",
"display": "Total Acreage",
"name": "Total Acreage",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Disturbed.cAcreage",
"display": "Disturbed Acreage",
"name": "Disturbed Acreage",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Flood.cZone",
"display": "Flood Zone",
"name": "Flood Zone",
"type": "Enumeration",
"enumerations": [
{
"id": "NAVD A - No Base Flood Elev. Determined",
"display": "NAVD A - No Base Flood Elev. Determined"
},
{
"id": "NAVD A99",
"display": "NAVD A99"
},
{
"id": "NAVD AE - Base Flood Elev. Determined",
"display": "NAVD AE - Base Flood Elev. Determined"
},
{
"id": "NAVD AH",
"display": "NAVD AH"
},
{
"id": "NAVD AO",
"display": "NAVD AO"
},
{
"id": "NAVD D",
"display": "NAVD D"
},
{
"id": "NAVD VE Coastal Flooding, Velocity Wave; Elevation",
"display": "NAVD VE Coastal Flooding, Velocity Wave; Elevation"
},
{
"id": "NAVD X - Shaded - Outside 100 Yr Flood",
"display": "NAVD X - Shaded - Outside 100 Yr Flood"
},
{
"id": "NAVD X Unshaded - Outside 500 Yr Flood",
"display": "NAVD X Unshaded - Outside 500 Yr Flood"
}
],
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Base.cFlood.cElevation",
"display": "Base Flood Elevation",
"name": "Base Flood Elevation",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Not.cin.cFlood.cZone",
"display": "Not in Flood Zone",
"name": "Not in Flood Zone",
"type": "Checkbox",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
}
],
"security": "F",
"entityState": "Unchanged"
},
{
"id": "ZONING",
"display": "ZONING",
"items": [
{
"value": "",
"id": "Zoning.c1",
"display": "Zoning 1",
"name": "Zoning 1",
"type": "Text",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Zoning.c2",
"display": "Zoning 2",
"name": "Zoning 2",
"type": "Text",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Zoning.c3",
"display": "Zoning 3",
"name": "Zoning 3",
"type": "Text",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Land.cUse.c1",
"display": "Land Use 1",
"name": "Land Use 1",
"type": "Text",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Land.cUse.c2",
"display": "Land Use 2",
"name": "Land Use 2",
"type": "Text",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Land.cUse.c3",
"display": "Land Use 3",
"name": "Land Use 3",
"type": "Text",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Parking.cSpaces.cRequired",
"display": "Parking Spaces Required",
"name": "Parking Spaces Required",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Parking.cSpaces.cProvided",
"display": "Parking Spaces Provided",
"name": "Parking Spaces Provided",
"type": "Float",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Planning.cCase.cRequired",
"display": "Planning Case Required",
"name": "Planning Case Required",
"type": "YesNo",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"value": "",
"id": "Required.cPlanning.cCase.cType",
"display": "Required Planning Case Type",
"name": "Required Planning Case Type",
"type": "Text",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
}
],
"security": "F",
"entityState": "Unchanged"
}
],
"security": "F"
}
]
}
}###Create/Update record ASI in version 4
HTTP Method: PUT
Documentation - Update Record Custom Forms
API: https://apis.accela.com/v4/records/{recordId}/customForms Example: https://apis.accela.com/v4/records/14CAP-00000-000B7/customForms
Sample Request - You can get the field names and the id from Get All Custom Forms for Record.
[
{
"id": "BLD_RES-GENERAL",
"Existing Use": "1 & 2 Family Residential"
}
]Sample Response
{
"status": 200,
"result": [
{
"id": "BLD_RES-GENERAL",
"isSuccess": true
}
]
}###Create/Update record ASIT in version 3
HTTP Method: PUT
URL: https://apis.accela.com/v3/records/{id} Example: https://apis.accela.com/v3/records/14CAP-00000-000B7
Sample Request - easiest way do this would be to do a GET of https://apis.accela.com/v3/records/14CAP-00000-000B7/asits to get the current ASIT rows, fields and values, you'll you the format of this response and drop it into the update record request below. Basically the ASITs array is the output form the Get Record ASIT. From here you can edit the value property of any of the fields in the items array.
{
"updateRecord": {
{
"ASITs": [
{
"id": "BLD_STANDARD-PLANS.cSUBMITTED",
"display": "BLD_STANDARD/PLANS SUBMITTED",
"security": "F",
"subId": "PLANS.cSUBMITTED",
"subDisplay": "PLANS SUBMITTED",
"subSecurity": "F",
"columns": [
{
"id": "Plan.cType",
"display": "Plan Type",
"name": "Plan Type",
"type": "Enumeration",
"enumerations": [
{
"id": "Civil",
"display": "Civil"
},
{
"id": "Architectural",
"display": "Architectural"
},
{
"id": "HVAC",
"display": "HVAC"
},
{
"id": "Plumbing",
"display": "Plumbing"
},
{
"id": "Electrical",
"display": "Electrical"
},
{
"id": "Hydro",
"display": "Hydro"
},
{
"id": "Fire Site",
"display": "Fire Site"
},
{
"id": "Fire Assembly",
"display": "Fire Assembly"
},
{
"id": "Health",
"display": "Health"
},
{
"id": "Water",
"display": "Water"
}
],
"defaultValue": "",
"inputRequired": true,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Number.cof.cSets",
"display": "Number of Sets",
"name": "Number of Sets",
"type": "Float",
"defaultValue": "",
"maxValue": 2147483647,
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Comments",
"display": "Comments",
"name": "Comments",
"type": "Text",
"defaultValue": "",
"security": "F",
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
}
],
"rows": [
{
"id": "PLANS.cSUBMITTED-1",
"display": "PLANS SUBMITTED",
"values": [
{
"id": "Plan.cType",
"value": "HVAC",
"entityState": "Changed"
},
{
"id": "Number.cof.cSets",
"value": "3",
"entityState": "Unchanged"
},
{
"id": "Comments",
"value": "Comments",
"entityState": "Unchanged"
}
],
"entityState": "Unchanged"
}
]
}
]
}
}
}
###Create/Update record ASIT in version 4
Documentation - Update Record Custom Tables
HTTP Method: PUT
URL: https://apis.accela.com/v4/records/{recordId}/customTables Example: https://apis.accela.com/v4/records/14CAP-00000-000B7/customTables
Sample Request - You can get the format for the request from querying the current ASI by calling Get Custom Table for Record, the response will give you the id, rows array, row id and fields. You will need to add an action property that is either add or update depending on the desired action.
[
{
"id": "BLD_STANDARD-PLANS.cSUBMITTED",
"rows": [
{
"id": "1",
"action": "update",
"fields": {
"Comments": "Comments",
"Plan Type": "HVAC",
"Number of Sets": "3"
}
}
]
}
]Sample Response
{
"status": 200,
"result": [
{
"id": "BLD_STANDARD-PLANS.cSUBMITTED",
"isSuccess": true
}
]
}