Staff Profiles
Please note that in all urls & code samples you'll need to replace:username
and :corporation
with appropriate values
Get Individual Staff
GET
/v2/organization/:corporation/staff/:username
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Url
Name | Type | Description |
---|---|---|
corporation | number | Corporation ID |
username | string | Unique username |
Response
Code
Create Staff
POST
/v2/organization/:corporation/staff
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Url
Name | Type | Description |
---|---|---|
corporation | number | Corporation ID |
username | string | Unique username |
Body
Name | Type | Description |
---|---|---|
firstname* | string | First Name |
lastname* | string | Last Name |
job_title* | string | Job |
email* | string | |
company* | string | Company |
department | string | Department |
phone_number | string | Phone # |
phone_number_extension | string | Phone extension |
location_city | string | City |
location_state | string | State/Province See full list here |
location_country | string | Country See full list here |
location_postal | string | ZIP/Postal Code |
location_address | string | Address |
location_building | string | Building |
location_room | string | Room # |
Response
Code
Update Staff
PUT
/v2/organization/:corporation/staff/:username
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Url
Name | Type | Description |
---|---|---|
corporation | number | Corporation ID |
username | string | Unique username |
Body
Name | Type | Description |
---|---|---|
firstname | string | First Name |
lastname | string | Last Name |
job_title | string | Job |
string | ||
company | string | Company |
department | string | Department |
phone_number | string | Phone # |
phone_number_extension | string | Phone extension |
location_city | string | City |
location_state | string | State/Province See full list here |
location_country | string | Country See full list here |
location_postal | string | ZIP/Postal Code |
location_address | string | Address |
location_building | string | Building |
location_room | string | Room # |
is_published | number | Published(1 or 0) |
is_private | number | Private(1 or 0) |
Response
Code
Delete Staff
DELETE
/v2/organization/:corporation/staff/:username
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Url
Name | Type | Description |
---|---|---|
corporation | number | Corporation ID |
username | string | Unique username |
Response
Code
Last updated