Skip to content

Instantly share code, notes, and snippets.

@axtheset
Last active August 29, 2015 14:02
Show Gist options
  • Save axtheset/b808357697b4bdda49be to your computer and use it in GitHub Desktop.
Save axtheset/b808357697b4bdda49be to your computer and use it in GitHub Desktop.
Accela Construct API - Searching records in v3

Search by custom id (aka altID, permit number, case number, etc...)

API: https://apis.accela.com/v3/search/records

Documentation: https://developer.accela.com/Resource/ApiHelpDetail/167473760.htm

A % symbol may be used as a wildcard in the search.

Request payload

{
  "filter": {
  	"aliases": ["BLD14-00071"],
  }
}

Response if found

{
    "page": {
        "totalRows": 1
    },
    "records": [
        {
            "addresses": [
                {
                    "id": "1000599970",
                    "display": "2633 Camino Ramon Dr, San Ramon, CA, 90210",
                    "houseNumber": "2633",
                    "streetName": "Camino Ramon",
                    "streetSuffix": "Dr",
                    "state": "CA",
                    "postalCode": "90210",
                    "city": "San Ramon",
                    "isPrimary": "True",
                    "entityState": "Unchanged"
                }
            ],
            "display": "BLD14-00071",
            "module": "Building",
            "assignToInfo": {
                "totalJobCost": "0.0"
            },
            "id": "14CAP-00000-0003P",
            "type": {
                "id": "Building-Residential-New-NA",
                "display": "Residential New"
            },
            "status": {
                "id": "Plan.cReview-BLD_GENERAL",
                "display": "Plan Review"
            },
            "openDate": "2014-05-29"
        }
    ]
}

Response if not found

{
    "page": {}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment