Data import

This chapter describes JSON-based import structure for account, users and vendors.

JSON-based accounts import

Structure

To import accounts and their users into ScheduleInterpreter® prepare information utilizing JSON-structured file, formatted using array of users and their corresponding information.

"_comment" key is always ignored during import.

[{
	"account": {
		"_comment": "general user information",
		"name": "General hospital",
		"timeZoneID": "2",
		"registerDate": "2012-01-01 03:00:00",
		"eMail": "michael.smith@gmail.com",
		"si_id": "98765"
	},
	"accountContact": [{
		"_comment": "Account's contact info, populates on Schedule Interpreter form",
		"street": "123 Main Street",
		"city": "Happy town",
		"state": "CA",
		"zip": "90210",
		"country_code": "US"
	}],
	"locations": [{
		"_comment": "Location where interpreting takes place",
		"name": "Cardiology",
		"street": "123 Main Street",
		"city": "Happy town",
		"state": "CA",
		"zip": "90210",
		"country_code": "US"
	}],
	"users": [{
		"user": {
			"_comment": "general user information",
			"fName": "Michael",
			"lName": "Smith",
			"userName": "michael.smith.123",
			"eMail": "michael.smith@gmail.com",
			"si_id": "98765"
		},
		"userContact": [{
			"_comment": "User address, will be used on invoice, when userType is set to 200 or 100",
			"street": "123 Main Street",
			"city": "Happy town",
			"state": "CA",
			"zip": "90210",
			"country_code": "US"
		}],
		"integration_code": [{
			"_comment": "user's codes in third party platforms",
			"platform_id": "2",
			"code": "12346",
			"field": "CLIENT_ID",
			"label": "Oracle Fusion client ID"
		}]
	}],
	"integration_code": [{
		"_comment": "account's codes in third party platforms",
		"platform_id": "2",
		"code": "12346",
		"field": "ACCOUNT_ID",
		"label": "Oracle Fusion account ID",
		"import_column": "18",
		"export_column": "23"
	}, {
		"_comment": "account's codes in third party platforms",
		"platform_id": "2",
		"code": "547865",
		"field": "SHIP_TO_CONTACT_PARTY_NUMBER",
		"label": "Ship-to Contact Party Number",
		"import_column": "14",
		"export_column": "36"
	}]
}]
KEYS AND DATA SECTIONS

 account  parent key contains general information about the account

Key Description Type Mandatory
name Account name String Yes
timeZoneID Time zone ID (account HQ) Integer Yes
isDaylight Flags account is in the location that supports daylight saving time Integer: 0 - no, 1 - yes Yes
registerDate Date when account was created String No
masterID ID of the master account generated by ScheduleInterpreter® Integer No
url Website of the account String No

When two tier structure is imported the first time, master accounts must be imported first.  Sub-account imported in second upload, using  masterID  key generated by ScheduleInterpreter® after initial import.

 accountContact  parent key contains address information. This information is populating in the Schedule Interpreter form, when request for services is being made.

Key Description Type Mandatory
street Street address String Yes
city City String Yes
state State String Yes
zip Postal code String Yes
country_code Country code String Yes

 locations  parent key contains information associated with locations of the account. This information is presented as multiple choice in the Schedule Interpreter form, when request for services is submitted. Address association with the location name is populating in the form, when request for services is being made.

Key Description Type Mandatory
name Location name String Yes
street Street address String Yes
city City String Yes
state State String Yes
zip Postal code String Yes
country_code Country code String Yes

 users  parent key contains general information about users

Key Description Type Mandatory
title User title (Mr., Mrs., etc.) String No
fName User first name String Yes
lName User last name String Yes
occupation Position, title, occupation String No
userName User name used for login String Yes
eMail User e-mail address String Yes
registerDate Registration date Date: yyyy-mm-dd No
comments Comments Text No
password User password (not encrypted) String No
userType Type of the user profile (default 102) Integer No
si_id ID assigned by ScheduleInterpreter® Integer No

 si_id  key is required for update process.

 userContact  parent key contains up to two contact entries.  Using is_business flag, import process will configure and secondary address for a vendor.

Key Description Type Mandatory
street Street address String Yes
city City String Yes
state State String Yes
zip Postal code String Yes
country_code Country code String Yes
phAC Phone area code Integer No
phPref Phone prefix Integer No
phSuf Phone suffix Integer No
phExt Phone extension Integer No
cellAC Cell area code Integer No
cellPref Cell prefix Integer No
cellSuf Cell suffix Integer No

 

JSON-based import reference tables

Special keys and their values used for imports

 platform_id  key values represent platform codes currently supported by ScheduleInterpreter®

Key Value Platform name
platform_id 1 Digium
platform_id 2 Oracle
platform_id 3 BoostLingo
platform_id 4 Lingo
platform_id 5 Abila
platform_id 6 Plunet
platform_id 7 ScheduleInterpreter VRI

 userType  key values represent user profile, when not specifically set, profile 102 is used.

Key Value Profile
userType 100 Administrator
userType 101 Manager
userType 102 User (default)
userType 200 Accounting manager
userType 201 Accounting user
userType 301 Scheduler

 timeZoneID  key values represent time zones, when not specifically set, Central Time Zone is used.

Key Value Time zone
timeZoneID 1 Eastern Time Zone
timeZoneID 2 Central Time Zone
timeZoneID 3 Mountain Time Zone
timeZoneID 4 Pacific Time Zone
timeZoneID 5 Alaska Time Zone
timeZoneID 6 Hawaii Time Zone
timeZoneID 7 UTC
timeZoneID 8 UTC +01:00
timeZoneID 9 UTC +02:00
timeZoneID 10 UTC +03:00
timeZoneID 11 UTC +04:00
timeZoneID 12 UTC +05:00
timeZoneID 13 UTC +06:00
timeZoneID 14 UTC +07:00
timeZoneID 15 UTC +08:00
timeZoneID 16 UTC +09:00
timeZoneID 17 UTC +10:00
timeZoneID 18 UTC +11:00
timeZoneID 19 UTC +12:00
timeZoneID 20 Atlantic Time Zone
timeZoneID 21 UTC -01:00
timeZoneID 22 UTC -02:00
timeZoneID 23 UTC -03:00
timeZoneID 24 UTC -11:00
timeZoneID 25 UTC -12:00

 country_code  key values represent platform codes currently supported by ScheduleInterpreter®

Key Value Country name Additional info
country_code AD  Andorra  
country_code AE  United Arab Emirates  
country_code AF  Afghanistan  
country_code AG  Antigua and Barbuda  
country_code AI  Anguilla  
country_code AL  Albania  
country_code AM  Armenia  
country_code AN  Netherlands Antilles  
country_code AO  Angola  
country_code AQ  Antarctica  
country_code AR  Argentina  
country_code AS  American Samoa  
country_code AT  Austria  
country_code AU  Australia  
country_code AW  Aruba  
country_code AX  Aland Islands  
country_code AZ  Azerbaijan  
country_code BA  Bosnia and Herzegovina  
country_code BB  Barbados  
country_code BD  Bangladesh  
country_code BE  Belgium  
country_code BF  Burkina Faso  
country_code BG  Bulgaria  
country_code BH  Bahrain  
country_code BI  Burundi  
country_code BJ  Benin  
country_code BM  Bermuda  
country_code BN  Brunei Darussalam  
country_code BO  Bolivia  
country_code BR  Brazil  
country_code BS  Bahamas  
country_code BT  Bhutan  
country_code BV  Bouvet Island  
country_code BW  Botswana  
country_code BY  Belarus  
country_code BZ  Belize  
country_code CA  Canada  
country_code CC  Cocos (Keeling) Islands  
country_code CD  Congo  The Democratic Republic of the
country_code CF  Central African Republic  
country_code CG  Congo  
country_code CH  Switzerland  
country_code CI  Cote d'Ivoire  
country_code CK  Cook Islands  
country_code CL  Chile  
country_code CM  Cameroon  
country_code CN  China  
country_code CO  Colombia  
country_code CR  Costa Rica  
country_code CU  Cuba  
country_code CV  Cape Verde  
country_code CX  Christmas Island  
country_code CY  Cyprus  
country_code CZ  Czech Republic  
country_code DE  Germany  
country_code DJ  Djibouti  
country_code DK  Denmark  
country_code DM  Dominica  
country_code DO  Dominican Republic  
country_code DZ  Algeria  
country_code EC  Ecuador  
country_code EE  Estonia  
country_code EG  Egypt  
country_code EH  Western Sahara  
country_code ER  Eritrea  
country_code ES  Spain  
country_code ET  Ethiopia  
country_code FI  Finland  
country_code FJ  Fiji  
country_code FK  Falkland Islands (Malvinas)  
country_code FM  Micronesia  Federated States of
country_code FO  Faroe Islands  
country_code FR  France  
country_code GA  Gabon  
country_code GB  United Kingdom  
country_code GD  Grenada  
country_code GE  Georgia  
country_code GF  French Guiana  
country_code GG  Guernsey  
country_code GH  Ghana  
country_code GI  Gibraltar  
country_code GL  Greenland  
country_code GM  Gambia  
country_code GN  Guinea  
country_code GP  Guadeloupe  
country_code GQ  Equatorial Guinea  
country_code GR  Greece  
country_code GS  South Georgia and the South Sandwich Islands  
country_code GT  Guatemala  
country_code GU  Guam  
country_code GW  Guinea-Bissau  
country_code GY  Guyana  
country_code HK  Hong Kong  
country_code HM  Heard Island and McDonald Islands  
country_code HN  Honduras  
country_code HR  Croatia  
country_code HT  Haiti  
country_code HU  Hungary  
country_code ID  Indonesia  
country_code IE  Ireland  
country_code IL  Israel  
country_code IM  Isle of Man  
country_code IN  India  
country_code IO  British Indian Ocean Territory  
country_code IQ  Iraq  
country_code IR  Iran  Islamic Republic of
country_code IS  Iceland  
country_code IT  Italy  
country_code JE  Jersey  
country_code JM  Jamaica  
country_code JO  Jordan  
country_code JP  Japan  
country_code KE  Kenya  
country_code KG  Kyrgyzstan  
country_code KH  Cambodia  
country_code KI  Kiribati  
country_code KM  Comoros  
country_code KN  Saint Kitts and Nevis  
country_code KP  Korea  Democratic People's Republic of
country_code KR  Korea  Republic of
country_code KW  Kuwait  
country_code KY  Cayman Islands  
country_code KZ  Kazakhstan  
country_code LA  Lao People's Democratic Republic  
country_code LB  Lebanon  
country_code LC  Saint Lucia  
country_code LI  Liechtenstein  
country_code LK  Sri Lanka  
country_code LR  Liberia  
country_code LS  Lesotho  
country_code LT  Lithuania  
country_code LU  Luxembourg  
country_code LV  Latvia  
country_code LY  Libyan Arab Jamahiriya  
country_code MA  Morocco  
country_code MC  Monaco  
country_code MD  Moldova  Republic of
country_code ME  Montenegro  
country_code MG  Madagascar  
country_code MH  Marshall Islands  
country_code MK  Macedonia  
country_code ML  Mali  
country_code MM  Myanmar  
country_code MN  Mongolia  
country_code MO  Macao  
country_code MP  Northern Mariana Islands  
country_code MQ  Martinique  
country_code MR  Mauritania  
country_code MS  Montserrat  
country_code MT  Malta  
country_code MU  Mauritius  
country_code MV  Maldives  
country_code MW  Malawi  
country_code MX  Mexico  
country_code MY  Malaysia  
country_code MZ  Mozambique  
country_code NA  Namibia  
country_code NC  New Caledonia  
country_code NE  Niger  
country_code NF  Norfolk Island  
country_code NG  Nigeria  
country_code NI  Nicaragua  
country_code NL  Netherlands  
country_code NO  Norway  
country_code NP  Nepal  
country_code NR  Nauru  
country_code NU  Niue  
country_code NZ  New Zealand  
country_code OM  Oman  
country_code PA  Panama  
country_code PE  Peru  
country_code PF  French Polynesia  
country_code PG  Papua New Guinea  
country_code PH  Philippines  
country_code PK  Pakistan  
country_code PL  Poland  
country_code PM  Saint Pierre and Miquelon  
country_code PN  Pitcairn  
country_code PR  Puerto Rico  
country_code PS  Palestinian Territory  
country_code PT  Portugal  
country_code PW  Palau  
country_code PY  Paraguay  
country_code QA  Qatar  
country_code RE  Reunion  
country_code RO  Romania  
country_code RS  Serbia  
country_code RU  Russian Federation  
country_code RW  Rwanda  
country_code SA  Saudi Arabia  
country_code SB  Solomon Islands  
country_code SC  Seychelles  
country_code SD  Sudan  
country_code SE  Sweden  
country_code SG  Singapore  
country_code SH  Saint Helena  
country_code SI  Slovenia  
country_code SJ  Svalbard and Jan Mayen  
country_code SK  Slovakia  
country_code SL  Sierra Leone  
country_code SM  San Marino  
country_code SN  Senegal  
country_code SO  Somalia  
country_code SR  Suriname  
country_code ST  Sao Tome and Principe  
country_code SV  El Salvador  
country_code SY  Syrian Arab Republic  
country_code SZ  Swaziland  
country_code TC  Turks and Caicos Islands  
country_code TD  Chad  
country_code TF  French Southern Territories  
country_code TG  Togo  
country_code TH  Thailand  
country_code TJ  Tajikistan  
country_code TK  Tokelau  
country_code TL  Timor-Leste  
country_code TM  Turkmenistan  
country_code TN  Tunisia  
country_code TO  Tonga  
country_code TR  Turkey  
country_code TT  Trinidad and Tobago  
country_code TV  Tuvalu  
country_code TW  Taiwan  
country_code TZ  Tanzania  United Republic of
country_code UA  Ukraine  
country_code UG  Uganda  
country_code UM  United States Minor Outlying Islands  
country_code US  United States  
country_code UY  Uruguay  
country_code UZ  Uzbekistan  
country_code VA  Holy See (Vatican City State)  
country_code VC  Saint Vincent and the Grenadines  
country_code VE  Venezuela  
country_code VG  Virgin Islands  British
country_code VI  Virgin Islands  U.S.
country_code VN  Vietnam  
country_code VU  Vanuatu  
country_code WF  Wallis and Futuna  
country_code WS  Samoa  
country_code YE  Yemen  
country_code YT  Mayotte  
country_code ZA  South Africa  
country_code ZM  Zambia  
country_code ZW  Zimbabwe  

 

JSON-based vendor import

Structure

To import vendors into ScheduleInterpreter® prepare information utilizing JSON-structured file, formatted using array of users and their corresponding information.

"_comment" key is always ignored during import.

[{
	"user": {
		"_comment": "general user information",
		"fName": "Michael",
		"lName": "Smith",
		"userName": "michael.smith.123",
		"eMail": "michael.smith@gmail.com",
      	"si_id": "98765"
	},
	"userContact": [{
			"_comment": "primary contact details",
			"street": "123 Main Street",
			"city": "Happy town",
			"state": "CA",
			"zip": "90210",
			"country_code": "US"
		},
		{
			"_comment": "secondary contact details",
			"street": "123 Main Street",
			"city": "Happy town",
			"state": "CA",
			"zip": "90210",
			"country_code": "US",
			"is_business": "1"
		}
	],
	"skills": [{
		"_comment": "user's skillset",
		"langauge": "English",
		"native": "1",
		"transExp": "10",
		"interpExp": "10"
	}, {
		"_comment": "user's skillset",
		"langauge": "Spanish",
		"native": "0",
		"transExp": "10",
		"interpExp": "10"
	}],
	"integration_code": [{
		"_comment": "user's codes in third party platforms",
		"platform_id": "2",
		"code": "12346",
		"field": "VENDOR_ID",
		"label": "Oracle Fusion user ID",
		"import_column": "18",
		"export_column": "23"
	}, {
		"_comment": "user's codes in third party platforms",
		"platform_id": "2",
		"code": "123 Main Street",
		"field": "VENDOR_SITE_CODE",
		"label": "Vendor site code",
		"import_column": "9",
		"export_column": "18"
	}]
}]
Keys and data sections

 user  parent key contains general information

Key Description Type Mandatory
title User title (Mr., Mrs., etc.) String No
fName User first name String Yes
lName User last name String Yes
nickName User nickname String No
isBusiness Indicates user as a business Integer: 0 - no, 1 - yes No
bName Name of the business String No
name_qb Name of account for QB String No
occupation Position, title, occupation String No
userName User name used for login String Yes
eMail User e-mail address String Yes
registerDate Registration date Date: yyyy-mm-dd No
isW2 Indicates user is an employee Integer: 0 - no, 1 - yes No
comments Comments Text No
password User password (not encrypted) String No
dob Date of birth Date: yyyy-mm-dd No
skype Skype address String No
isVideo indicates if user provides video services Integer: 0 - no, 1 - yes No
isPhone indicates if user provides OPI services Integer: 0 - no, 1 - yes No
isConference indicates if user provides conference services Integer: 0 - no, 1 - yes No
branchID ID of the branch user belongs to Integer No
si_id ID assigned by ScheduleInterpreter Integer No

 si_id  key is required for update process.

 userContact  parent key contains up to two contact entries.  Using is_business flag, import process will configure and secondary address for a vendor.

Key Description Type Mandatory
street Street address String Yes
city City String Yes
state State String Yes
zip Postal code String Yes
country_code Country code String Yes
phAC Phone area code Integer No
phPref Phone prefix Integer No
phSuf Phone suffix Integer No
phExt Phone extension Integer No
cellAC Cell area code Integer No
cellPref Cell prefix Integer No
cellSuf Cell suffix Integer No
faxAC Fax area code Integer No
faxPref Fax prefix Integer No
faxSuf Fax suffix Integer No
intl_phone International phone number (office or landline) String No
intl_cell International cell phone String No
is_business Flags business (secondary) address Integer: 0 - no, 1 - yes No

 skills  parent key contains list of languages vendor can provide services in. Provide both, source and target languages. For example, vendor interpreting or translating from English into Spanish should have two entries.

Key Description Type Mandatory
language Name of the language String Yes
native Is native speaker of the language Integer: 0 - no, 1 - yes No
transExp Translation experience in years Integer No
interpExp Interpreting experience in years Integer No

 integration_code  parent key contains list of codes vendor is configured with in a third party platforms.

Key Description Type Mandatory
platform_id ID of the integration platform Integer Yes
code Code used in the third party platform String Yes
field Name of the field in the third party platform String Yes
label Human readable label of the field String No

 

Compliance documents import

Prepare import structure

Prepare your import by creating a list of all documents and their categories. The list should be stored in a Microsoft Excel format with a single sheet. Column A should be populated with names of the documents and column B should be populated with the categories.  There are 7 categories of the compliance documents: background check, vaccination and screening, education, license, certification, professional services, miscellaneous.

Plan your compliance documents import carefully, once imported, change of categories is not possible. When not sure, use miscellaneous as a default category

Vendor folders

Create two folders and name them active and non active. If you have vendors who are no longer working with your organization but you need to import their profiles for compliance purpose use non active folder to store their information.

When importing documents for the vendors and the vendor ID is known, it should be included in the name of the folder containing all document.  For example, Doe, Jane [1234] or Doe, John [4321]. 

How to prepare the documents

Each document must be stored as a PDF file.  Files can contain multiple pages. All protection such as password or encryption must be removed. Documents must be named as they are listed in PREPARE IMPORT STRUCTURE, under column A.  All documents must include the date of submission in a format YYYY-MM-DD.  For example, Influenza - 2019-06-28.pdf or FBI criminal background check - 2018-02-15.pdf. When all documents are collected, the folder they are stored in should be named documents and compressed using zip tools. 

The following diagram provides visual representation on how the documents should be prepared for import. 

Uploading for import

When import file is completed, use 3rd party solutions supporting uploads of files larger than 4Gb to securely store the file. Share the file, setting support.desk@scheduleinterpreter.com as an authorized e-mail and protect it with a password.  Login to your account in ScheduleInterpreter® Community and provide link and password to access the file.

Services import

For initial import of services (languages) create a Microsoft Excel file and list all languages in the column A. The order, in which the languages are listed is not important.  ScheduleInterpreter® will sort all services in alphabetical order, when the list is generated.

Make sure spelling and capitalization of the services are accurate. This is how your services will appear on the screen for your staff, vendors and clients.

The table below provided as a reference only.

Acholi Flemish Kurdish Russian
Afrikaans French Kurmanji Samoan
Akan French Canadian Kyrgyz Serbian
Albanian Fukienese Lakota Shanghainese
Amharic Fula Laotian Shona
Arabic Fulani Latvian Sichuan
Ashante Fuzhou Lingala Sicilian
Asl Ga Lithuanian Sinhalese
Assyrian Gaddang Luganda Slovak
Azerbaijani Gaelic Luo Somali
Azeri Gaelic-irish Maay Sorani
Bajuni Gaelic-scottish Macedonian Spanish
Basque Georgian Malay Sudanese Arabic
Behdini German Malayalam Sundanese
Belorussian Gorani Maltese Susu
Bengali Greek Mandarin Swahili
Berber Gujarati Mandingo Swedish
Bosnian Haitian Creole Mandinka Sylhetti
Bravanese Hakka Marathi Tagalog
Bulgarian Hakka-chinese Marshallese Taiwanese
Burmese Hausa Mien Tajik
Cakchiquel Hebrew Mina Tamil
Cambodian Hindi Mirpuri Telugu
Cantonese Hmong Mixteco Thai
Catalan Hungarian Moldavan Tibetan
Chaldean Ibanag Mongolian Tigre
Chamorro Ibo Montenegrin Tigrinya
Chao-chow Icelandic Navajo Toishanese
Chavacano Igbo Neapolitan Tongan
Chin Ilocano Nepali Toucouleur
Chuukese Indonesian Nigerian Pidgin Trique
Cree Inuktitut Norwegian Tshiluba
Croatian Italian Oromo Turkish
Czech Jakartanese Pahari Twi
Dakota Japanese Papago Ukrainian
Danish Javanese Papiamento Urdu
Dari Kanjobal Pashto Uyghur
Dinka Karen Patois Uzbek
Diula Karenni Pidgin English Vietnamese
Dutch Kashmiri Polish Visayan
Edo Kazakh Portug.creole Welsh
English Kikuyu Portuguese Wolof
Estonian Kinyarwanda Pothwari Yiddish
Ewe Kirundi Pulaar Yoruba
Fante Korean Punjabi Yupik
Farsi Kosovan Putian  
Fijian Hindi Kotokoli Quichua  
Finnish Krio Romanian