Rethink Staff Get/Post API

Staff General Information

#

Field

Data Type

Max Length

Description

Required

Expected Values

Error Message

1

staffId

number

20

Rethink Staff ID. This will be null in case a new staff is being created. Rethink will assign a Staff ID. If the staff is being updated, the staff ID will need to be sent to Rethink

Situational

1234

Invalid StaffID: ID does not exist under this Company Account

Invalid Format - Must be a number

Exceeds Max Length

2

username

string

100

Username of the Staff Member

Yes

janedoe1

Invalid Format: Must be a string

Exceeds Max Length

Username already exists in the system

Minimum length of the username should be 6 characters

3

statusId

number

10

Status ID connected to the Staff Status should be passed. The Status IDs are the IDs for statuses configured in the Company Account > Staff Settings > Staff Statuses. The Status IDs will be provided by Rethink during implementation.

Yes

11

Invalid Status Id. Status Id does not exist under this account.

Exceeds Max Length

4

companyStaffId

string

100

External System Assigned Staff ID for the Staff

No

 445667

Exceeds Max Length

5

firstName

string

100

Staff Member's First Name

Yes

Jane

Exceeds Max Length

6

middleName

string

100

Staff Member's Middle Name

No

Mary

Exceeds Max Length

7

lastName

string

100

Staff Member's Last Name

Yes

Doe

Exceeds Max Length

8

dateOfBirth

string

10

Staff Member's Date of Birth.

No

1965-12-12

Invalid Format: Must be a date format

9

phone

string

13

Contact Number of the Staff

No

7879898877

Exceeds Max Length

10

addressStreet

string

100

Staff Member's Street Address

No

123 Avenue

Exceeds Max Length

11

city

string

100

Staff Member's City

No

Miami

Exceeds Max Length

12

stateId

number

2

ID associated with the with the State. See Appendix for State.

No

FL

Exceeds Max Length

Invalid Format - Must be a number

Invalid State ID . Valid range of values is 1-52.

13

zipCode

string

9

5 or 9 digit Zip Code
No dashes allowed

No

331780000

Exceeds Max Length

Invalid Format - Dashes are not supported

14

timeZoneId

string

 100

See TimeZone data dictionary Appendix 8.0. Time Zone

 Yes

Invalid Time Zone

15

locationIds

list of numbers

Location ID(s) associated to the intended location should be passed. The Location IDs are the IDs for the Location configured in Company Account > Locations > Location. The Location IDs will be  provided by Rethink during implementation. Multiple locations should be sent as list of location IDs

Yes

1

Invalid Location Id. Location Id does not exist under this account.

Invalid Format - Must be a number.

16

employeeTypeId

number

10

Employee Type ID are the IDs for the the Employee Types configured in Company Account > Staff Member Settings > Employee Types. The Employee Type ID will be  provided by Rethink during implementation.

No

1

Invalid Employee Type Id. Employee Type Id does not exist under this account.

Invalid Format - Must be a number.

17

roleId

number

10

Role IDs for Staff are the IDs that define role of the staff and inherit permissions based on role of the staff. Role ID of the Role are configured in Company Account > Roles. The Role ID will be provided by Rethink during implementation.

Yes

1

Invalid Submission: Value does not exist under this Company Account

18

email

string

200

Staff Member's Email

Yes

abc@test.com

Invalid Format: Must be email format

Exceeds max length

Email already exists in the system

19

npiNumber

string

10

Staff Member's NPI Number

No

1801424978

Invalid Format: Must be an number

Exceeds max length

Invalid NPI Number

20

medicaidNumber

string

15

Staff Member's Medicaid Number

No

1122334455

Invalid Format: Must be an number

Exceeds max length

21

practionerId

string

 20

Staff Member's Practitioner ID

No

 938874655678767

Invalid Format: Must be an number

Exceeds max length

22

taxonomyCode

string

10

Unique alphanumeric code to designate provide classification and specialization

No

651044004

Invalid Format: Must be a string

Exceeds max length

23

supervisorId

number

20

Supervisor assigned to the staff member.
Supervisor ID should be one of the staffId values
Supervisor ID cannot be same as the Staff Member ID of the record sent

No

23

Exceeds Max Length

supervisorId is same as staffId

Invalid supervisorId

24

serviceLineIds

list of numbers

10

Service Line ID associated to the intended Service Line should be passed. The Service Line IDs are the IDs for values configured in the Company Account > Service Lines. The Service Line ID will be provided by Rethink during implementation.
Multiple Service Lines can be passed as a list of numbers.

No

2

Invalid Submission: Value does not exist under this Company Account

25

funderIds

list of numbers

100

Funder ID associated to a Funder should be passed. Funder IDs will be provided by Rethink during implementation. the Funders configured in Company Account > Funders > Name

No

1

Invalid Submission: Value does not exist under this Company Account

26

List of Availabilities

staffAvailability

List<staffAvailability>

No

List of Availability for Staff