This service and API endpoint provide customers means to upload files to &frankly for providing user & organizational data to us for import into &frankly.
There are some options in regards to what file and file formats that can be used, read more below in the Different file formats section.
The upload service is available as :
- API (REST/HTTPS)
- Secure FTP (SFTP)
The hostname/base URL is the same for both endpoints: upload.api.andfrankly.com
Read more here: &frankly upload API & service | API Reference
Note: This is not the same API as the &frankly organization API (&frankly organization API | API Reference)
File formats
Excel file
Tip: When uploading an Excel file you can add user information and group information in the same file but on different sheets.
Requirements and Restrictions:
- The header line (first row) should be named exactly as it says below otherwise that column will be handled as an attribute in &frankly.
- If a field is empty the upload API will skip that value.
- Supported file extensions are: xls, xlsx
- Encoding needs to be UTF-8
You can find an example file here: Excel file
Field descriptions:
| Sheet name = Users | ||
|
Header/Name/First row |
Example value |
Note |
|
EmployeeID |
E123456 |
Column & value mandatory, must be in column 1 |
|
FirstName |
Testman |
Column & value mandatory, must be in column 2 |
|
LastName |
Foobar |
Column & value mandatory, must be in column 3 |
|
|
Value optional (If there is a value for PhoneNumber) , Column mandatory (must be on column 4) |
|
|
PhoneNumber |
+00 1234 567 |
Value optional (if there is a value for Email). Need to have the country code in beginning and correct number format for that country(+46 XXX XXXXXX) |
|
IsManager |
1 |
Optional. Provides role manager to this user. |
|
Department |
DEP_001 |
Optional. Can be repeated if users should be member in more then one group. This is externalid on group. |
|
DepartmentName |
Sales team |
Optional. Can be repeated if users should be member in more then one group. This is name on group. Will not be used if Department is set. |
|
EmployeeManagerID |
E654321 |
Optional. The externalid on the manager.This will add this user as manager on groups that this person is member of. |
|
EmployeeManagerName |
foo barsson |
Optional. The externalid on the manager.This will add this user as manager on groups that this person is member of. Will not be used if ManagerID is set. |
|
Active |
0 |
Optional. If empty it will leave user at is current state. Values: 1 / 0 |
|
Language |
sv |
Optional (BCP47) |
|
Sheetname = Groups |
|
|
|---|---|---|
|
Header/Name/First row |
Example value |
Note |
|
OrgUnitID |
DEP_001 |
Column & value mandatory, must be in column 1 |
|
Name |
HR |
Column & value mandatory, must be in column 2 |
|
Description |
HR Department |
Column mandatory, value optional, must be in column 3 |
|
ResponsibleManager |
E654321 |
Column mandatory, value optional, must be in column 4. The externalid on manager. This will add this user as manager on this group |
|
ParentOrgUnit |
DEP_002 |
Column mandatory, value optional, must be in column 5. The OrgUnitID of the parent group (if not set will then be top/root group). |
Csv User file
Requirements and restrictions:
- Header line (first row) is name the exactly as it says below otherwise that column will be handled as an attribute in &frankly.
- If a field is empty the upload API will skip that value.
- Supported formats are : csv files separated with ; (semi colon) or | (pipe).
- Encoding needs to be UTF-8
You can find an example file here: example_user.csv
|
Header/Name/First row |
Example value |
Note |
|---|---|---|
|
Employee ID |
E123456 |
Column & value mandatory, must be in column 1 |
|
First Name |
Testman |
Column & value mandatory, must be in column 2 |
|
Last Name |
Foobar |
Column & value mandatory, must be in column 3 |
|
|
Value optional (If there is a value for PhoneNumber) , Column mandatory (must be on column 4) |
|
|
PhoneNumber(Optional) |
+00 1234 567 |
Value optional (if there is a value for Email). Need to have the country code in the beginning and the correct number format for that country(+46 XXX XXXXXX) |
|
IsManager |
1 |
Optional. Provides role manager to this user. |
|
Group memberships |
DEP_001 |
Optional. Can be repeated if users should be member in more then one group. This is OrgUnitID on group. |
|
Group Name |
Sales team |
Optional. It can be repeated if users should be members in more than one group. This is externalid on group. It will not be used if "Group memberships" is set. |
|
Employee ManagerID |
E654321 |
Optional. The Employee ID on the manager.This will add this user as manager on groups that this person is member of. |
|
Active |
0 |
Optional. If empty it will leave user at is current state |
|
Language |
sv |
Optional (BCP47) |
Csv Group file
Requirements and restrictions:
- Header line (first row) must to be present for all 5 columns
- If a field is empty the upload API will skip that value.
- Supported formats are : csv files separated with ; (semi colon) or | (pipe).
- Encoding needs to be UTF-8
You can find an example file here: example_groups.csv
|
Header/Name/First row (all mandatory) |
Example value |
Note |
|
OrgUnitID |
DEP_001 |
Column & value mandatory, must be in column 1 |
|
Name |
HR |
Column & value mandatory, must be in column 2 |
|
Description |
HR Department |
Column mandatory, value optional, must be in column 3 |
|
ResponsibleManager |
E654321 |
Column mandatory, value optional, must be in column 4. The externalid on manager. This will add this user as manager on this group |
|
ParentOrgUnit |
DEP_002 |
Column mandatory, value optional, must be in column 5. The OrgUnitID of the parent group (if not set will then be top/root group). |