PUT: ADD PRACTITIONER

Type:PUT

Method:practitioner

Parameters: n/a

URL Example:https://www.bizstim.com/api/practitioner

Input Variables:
ELEMENT TYPE DESCRIPTION
first_name string required
last_name string required
wage_tier integer required (0=hourly, 1=salary hours, 2=salary annual)
state string required
country string required
status string required (inactive, active, contactList, doNotHire)
city string optional
text_phone string optional (format: 9055551111,9055552222)
email string optional (format: blah@mail.com,bah@mail.com)
address1 string optional
address2 string optional
zipcode string optional
p_phone string optional
s_phone string optional
password string optional
password2 string optional (confirm password)
username string optional (must be unique)
hire_date string optional (YYYY-MM-DD)
add_value float (format: 1.25) optional
timezone string (see note below) optional
meeting_url string optional
skill_id array optional (array of skill ID's assigned to the practitioner)
notes string optional
mAvailf string optional (Monday Start Time - HH:MM)
mAvailt string optional (Monday End Time - HH:MM)
tAvailf string optional (Tuesday Start Time - HH:MM)
tAvailt string optional (Tuesday End Time - HH:MM)
wAvailf string optional (Wednesday Start Time - HH:MM)
wAvailt string optional (Wednesday End Time - HH:MM)
rAvailf string optional (Thursday Start Time - HH:MM)
rAvailt string optional (Thursday End Time - HH:MM)
fAvailf string optional (Friday Start Time - HH:MM)
fAvailt string optional (Friday End Time - HH:MM)
satAvailf string optional (Saturday Start Time - HH:MM)
satAvailt string optional (Saturday End Time - HH:MM)
sunAvailf string optional (Sunday Start Time - HH:MM)
sunAvailt string optional (Sunday End Time - HH:MM)

  • * For the timezone field use the Timezone get method and select an appropriate value from the TimeZone field.
  • * If the timezone is unrecognized or empty, America/New_York will be applied as default.
  • * When a skill_id array is present it must consist of skill ID's. Do not use named keys. These skills will be assigned to the practitioner. You do not have to set this variable if you do not want to assign skills to the practitioner.

Response Example:
{
    "id": 16548,
    "status": "success",
    "code": 6,
    "response": "The practitioner was added successfully."
}

Element Properties:
ELEMENT TYPE DESCRIPTION
id integer Practitioner ID
status string success or failure
code integer
0 failure: validation errors
1 failure: required fields missing
2 failure: practitioner already exists
3 failure: passwords do not match
4 failure: username is not unique
5 failure: unable to create practitioner
6 success
response string

Possible responses are:

  • An unordered list (ul) of validation errors
  • Practitioner information missing.
  • There is already a practitioner with that name.
  • Passwords do not match.
  • That username is already taken.
  • Unable to create the practitioner.
  • The practitioner was added successfully.