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