Junction Networks

Junction Networks Web Services API

E911LocationAdd

Update an E911 Emergency Response Location (ERL) record.

An ERL is a specific geographic location provided to the Public Safety Answering Point (PSAP) and to which a 911 emergency response team may be dispatched. A PSAP is a call center responsible for answering calls to an emergency telephone number for police, firefighting, and ambulance services.

In a large enterprise, the PBX administrator may break down the campus or enterprise area into several different ERLs. This way, the PSAP is provided with location information which is more precise than simply the main address. For instance, each building on the enterprise campus, or floor or wing in the enterprise building, may be considered its own ERL, and within a given ERL there may be several phones or extensions. In some states, regulations require that enterprises maintain ERLs of specific sizes or identifiable areas (i.e. ERL per 1000 square feet or per floor).

An E911Location record may be "Shared" or "Private". Shared location records may be assigned to zero or more users within an origanization and are typically used for offices where many people are utilizing the same address. Private location records are assigned to zero or one user and are typically used for home offices or remote workers.

An E911Location record is assigned to a UserAddress using the E911LocationAssign API call.

City-State-Zip provisioning is implemented when a location cannot be validated as a "Full" address. If only the city, state, and zip-code pass validation, then the address will be accepted as a CSZ entry. This functionality increases the total number of locations that may be provisioned, which ensures that 911 service can be maintained for the maximum amount of users. However, this functionality should be used sparingly, and a “Full” address should be validated whenever possible.

How to implement CSZ: a) attempt to validate a location with the “CszOnly” field set to “false”, b) if validation fails, prompt the user with the alternative addresses provided, c) if the set of alternatives fails, send a request with the “CszOnly” field set to “true”. The use of CSZ functionality does not automatically guarantee that an address will be validated. The city, state, and zip-code must be valid for the address to be provisioned.

Authentication

This action requires an Authenticated Session.

Authorization

This action requires Organization/User Update permission.

If the location is a "Shared" location, then we need to be be able to update that organization.
If the location is a "Private" location, then we need update on user to which the location belongs.

Parameters

One and only one of the following (Required)
OrganizationId
A positive integer which references a unique Organization.
UserId
A positive integer which references a unique User.
LocationType
Required
"Shared" (multiple addresses within an org may be assigned to a shared location), or "Private" (a single address belonging to a single user may be assigned to a private location)
LocationName
Required
A name for the E911 Emergency Response Location. For example, "Acme Corporate Headquarters".
StreetNumber
Required
The location's street number. Maximum of 10 characters.
StreetName
Required
The location's street name. Maximum of 50 characters.
AddressType
Optional
One of: "Apartment", "Basement", "Building", "Department", "Floor", "Front", "Hanger", "Key", "Lobby", "Lot", "Lower", "Office", "Penthouse", "Pier", "Rear", "Room", "Side", "Slip", "Space", "Stop", "Suite", "Trailer", "Unit", "Upper"
AddressTypeNumber
Optional
Maximum of 50 characters. Used to qualify the address type. For example, if address type is "Floor", address type number might be "20".
City
Required
The location city.
State
Required
The location state. Must contain 2 characters. Ex: "FL" for Florida.
Country
Required
Must be "USA" or "CAN".
Zipcode
Required
Must be a US zip code (XXXXX or XXXXX-XXXX) or a Canadian postal code (X2X 2X2).
CszOnly
Optional
Default Value: false
City-State-Zip provisioning will be permitted if true; boolean (true/false).

Result RELAX NG Schema Modules

Main module: E911LocationAdd.rng

Supporting modules:  E911Location.rng

Result Element Example

Not available.