Update and Validate an Existing E911 Address

Lets you update and validate an existing E911 address on your account. You must create the E911 address first by following Create and Validate a New E911 Address.

Endpoint

PATCH /e911s/:e911_id

Request Parameters

Path Parameter

  • e911_id
    string REQUIRED

    The unique identifier for the E911 record you want to update.

Body Parameters

  • data
    object REQUIRED

    E911 object to be updated and validated which is composed of type and attributes.

    • type
      string REQUIRED

      Object type. This will always be e911.

    • attributes
      object REQUIRED

      Object composed of the different attributes of an E911 object. You can update one or more of the attribute fields below:

      • label string- Unique friendly name for the E911 address to be validated.

      • first_name string- First name associated with the E911 address to be validated.

      • last_name string- Last name associated with the E911 address to be validated.

      • street_number integer- The street number of the E911 address to be validated.

      • street_name string- The street name of the E911 address to be validated.

      • address_type string- Address type for the E911 address to be validated and added to your account, if applicable. You can set the address type to any of the following case-insensitive options:

        • Apartment
        • Basement
        • Building
        • Department
        • Floor
        • Front
        • Key
        • Lobby
        • Lot
        • Lower
        • Office
        • Penthouse
        • Pier
        • Rear
        • Room
        • Side
        • Slip
        • Space
        • Stop
        • Suite
        • Trailer
        • Unit
        • Upper

      • address_type_number string- Identifier associated with the address type. For example, A-1

      • city string- City where the E911 address to be validated is located.

      • state string- Two-letter abbreviated US state or Canadian province or territory in uppercase where the E911 city is located.

      • country string- Two-letter abbreviated country code in uppercase where the city and state or province of the E911 address are located. Valid options are US for USA and CA for Canada.

      • zip string- Valid US or Canada zip code for the E911 address to be validated. For example, 98104 for the US and M4C 5K7 for Canada.

Response Fields

On success, the HTTP status code in the response header is 200 OK and the response body contains an E911 object in JSON format. On error, the header status code is an error code and the response body contains an array of error objects.

If the address provided requires correction, then the response body will contain a list of errors, each with an object that contains the title Address Correction Required and a corrected address in the detail section.


Example Request

PATCH /v2/e911s/20155 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
  "data": {
    "type": "e911",
    "attributes": {
      "label": "Dr. Johnson"
    }
  }
}

Example Request

curl -X PATCH https://api.flowroute.com/v2/e911s/20155 -u accessKey:secretKey -d '{ "data": { "type": "e911", "attributes": { "label": "Dr. Johnson"}}}' -H 'Content-Type':'application/vnd.api+json'

Example Responses

Successful update and validate

200 OK

                {
    "data": {
    "attributes": {
        "address_type": "Suite",
        "address_type_number": "601",
        "city": "Seattle",
        "country": "US",
        "first_name": "Bob",
        "label": "First e911 record",
        "last_name": "Law",
        "state": "WA",
        "street_name": "Smith St",
        "street_number": "123",
        "zip": "98101"
    },
    "id": "20217",
    "links": {
        "self": "https://api.flowroute.com/v2/e911s/20217"
    },
    "type": "e911"
    }
}

No authorization provided

401 Unauthorized

{
  "errors": [
    {
      "detail": "Authentication failed.",
      "id": "7fc8c70a-ca58-430c-b383-b89df84f8083",
      "status": 401,
      "title": "Unauthorized"
    }
  ]
}

Resource not owned

403 Forbidden

{  "errors":
  [
    {
      "status": 403,
      "detail": "",
      "title": "ActionNotAuthorizedError"
    }
  ]
}

Address Correction Required

The submitted address is 4th Avenue S and the corrected address is 4TH AVE

E911 Request

    
    curl -X POST
         -u TECHPREFIX:APISECRETKEY
         -H "Content-Type: application/json"
         "https://api.flowroute.com/v2/e911s/validate"
         -d '{
            "data": {
                 "type": "e911",
                 "attributes": {
                     "label": "First",
                     "first_name": "Bob",
                     "last_name": "Smith",
                     "street_number": "2101",
                     "street_name": "4th Avenue S",
                     "city": "Seattle",
                     "state": "WA",
                     "zip": "98121",
                     "country": "US"
                }
            }
         }

422 UNPROCESSABLE ENTITY

    {
        "errors": [
            {
                "detail":{
                    "city":"SEATTLE",
                    "country":"US",
                    "first_name":"Bob",
                    "label":"First",
                    "last_name":"Smith",
                    "state":"WA",
                    "street_name":"4TH AVE",
                    "street_number":"2101",
                    "zip":"98121"
                },
                "id":"1c5b6a81-1f5d-4c77-a23a-7e273b731c12",
                "status":422,
                "title":"Address Correction Required"
            },
            {
                "detail":{
                    "city":"SEATTLE",
                    "country":"US",
                    "first_name":"Bob",
                    "label":"First",
                    "last_name":"Smith",
                    "state":"WA",
                    "street_name":"4TH AVE SOUTH",
                    "street_number":"2101",
                    "zip":"98121"
                },
                "id":"1c5b6a81-1f5d-4c77-a23a-7e273b731c12",
                "status":422,
                "title":"Address Correction Required"
            }
        ]
    }