Share911 Data Import - Employee Contact Information
API Version: 1
Last Modified: March 3, 2015
Contact: Adrian Lanning <firstname.lastname@example.org>
This document describes the data format used to import contact information into the Share911 platform. A typical use case for this is to enable the automated management of user information via a periodic (ex. nightly) data transfer from a customer's employee management system.
CSV (text/csv) with comma delimiter
The filename of the csv file indicates which date the file should be imported
on. The format of the filename is as follows:
Date = ISO 8601 date or date/time format (year - month - day)
Employee ID - String
A unique identifier for the employee that will never change.
Email Address - String
A unique email address for the employee. If an employee has multiple email
addresses, separate each email address with a semi-colon or comma and use
quotes around the entire field. All addresses will be added to the user's
Share911 account and the user can use any of their email addresses to log
in (this is useful when someone gets married.) Email notifications will be
sent to their primary email address which by default is the last one
ex. "email@example.com, firstname.lastname@example.org"
ex. "email@example.com; firstname.lastname@example.org"
Network ShareID - String
The Share911 identifier for the network which the user has access to. If the
user has access to multiple networks, separate each ShareID with a semi-
colon or comma and use quotes around the entire field.
ex. "acme.org/anvils, acme.org/rockets"
ex. "acme.org/anvils; acme.org/rockets"
Employment Status - One of the following values: 1, 2
A flag indicating whether the user is currently employed or not:
1 = Active
2 = Terminated
A terminated employee will have their access removed from the appropriate
network but their account will still be tied to their transaction history for
reporting purposes. Default: 1 (Active)
First Name - String
Employee's first or given name.
Last Name - String
Employee's last or family name.
Job Title - String
Short description of the position held by the employee.
Mobile Number - String
Employee's mobile (cellular) phone number. Must be unique. Must contain at
least 10 digits to be considered valid. Non-numeric characters are ignored.
ex. "555-555-5555", "5555555555", "(555) 555-5555", "1-555-555-5555"
Department - String
The name of the department or group to which the user belongs. Authorized
users can broadcast messages to all members of these groups. These groups
must match those specified for the user's networks.
ex. "ADMINISTRATORS", "ENGINEERING", "SECURITY"
Emergency Contact Name - String
The name of the person that should be contacted by first responders if the
employee is non-communicative (unconcious, on the way to the hospital and
unable to speak).
ex. "Margaret Smith"
Emergency Contact Number - String
The phone number of the person that should be contacted by first responders
Emergency Contact Email - String
The email address of the person that should be contacted by first responders
Field Order Template:
Employee ID, Employment Status, Email Address, Network ShareID, First Name, Last Name, Job Title, Department, Mobile Number, Emergency Contact Name, Emergency Contact Number, Emergency Contact Email
Employee ID, Employment Status, Email Address, Network ShareID, First Name, Last Name, Job Title, Department, Mobile Number, Emergency Contact Name, Emergency Contact Number, Emergency Contact Email 0122, 1, email@example.com, "acme.org/anvil, acme.org/rockets", Fred, Brown, CTO, 555-555-5555, ADMINISTRATORS 0123, , firstname.lastname@example.org, 90210B, John, "O'Leary", "Custodian, Lead", 5555555556, JANITORIAL, "Mary O'Leary", 5555555557, email@example.com 0124, , firstname.lastname@example.org, 00000A, Mike, Smith, Security Officer, 5555555558, SECURITY 0124, 1, email@example.com, 00000A 0125, 2, firstname.lastname@example.org, 00000A