CREATE profileImage
Create a profileImage object.
Parameters
Parameters | Detail |
---|---|
member_id required |
This is the ID of the member. Sample value: "11111111-1111-1111-1111-111111111111" |
photo required |
This is the profile picture of the member. Value must be file object. File size is restricted to 1MB maximum. Accepted Format: jpg, gif, png, jpeg. |
Resource Information
Authentication
: Required. See Authentication for details on authentication.
HTTP Methods
: POST
Request URL Format
: https://{api_domain}/api3/profileImage
Access Permission
Requester can create profileImage for his account. Admin can create profileImage for other member accounts.
Errors
- Invalid GUID received
- Attachment must be in JPG,GIF,PNG,JPEG format
- Upload Error: file too large
- Missing required parameter
Example Request
- Method: POST
- Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
- URL:
https://example.brightidea.com/api3/profileImage
Form data:
- member_id=DC73D12F-D2A7-4F3E-8837-3C3D2073F046
- photo: {File}
{ "member": { "id": "8FA49B96-3693-4282-8919-014618D7B3B8", "email": "mpower@example.com", "screen_name": "Max Power", "first_name": "Max", "last_name": "Power", "job_title": "Safety Inspector", "address": "742 Evergreen Terrace, Springfield, IL", "phone": "(123)456-7890", "mobile_phone": "(987)654-3210", "external_user_id": "0072", "skills": "Boxer, Mascot, Astronaut, Baby proofer, Truck driver, Hippie, Plow Driver, Food Critic", "work_history": "Conceptual Artist, Mayor, Country Western Manager, Garbage Commissioner, Mountain Climber", "photo_url": "https://example.brightideatest.com/api3/file/CCBCC6A7-98C9-48E1-92F3-0C05AAC78863?format=binary&thumb_size=100", "date_created": "2013-03-07 17:10:13.627", "date_modified": "2013-03-29 15:25:51.207", "active": true, "photo_file_id": "CCBCC6A7-98C9-48E1-92F3-0C05AAC78863", "department": "Human Resources", } }
DELETE profileImage
Delete a profileImage object. Requester can delete profileImage for his account. Admin can delete profileImage for other member accounts.
Parameters
Parameters | Detail |
---|---|
format optional |
Specifies returned data format Accepted value: "json", "xml" |
Resource Information
Authentication
: RequiredHTTP Methods
: DELETERequest URL Format
: https://{api_domain}/api3/profileImage/{id}
Access Permission
Requester can delete profileImage for his account. Admin can delete profileImage for other member accounts.
Errors
- Invalid GUID received
Example Request
- Method: DELETE
- Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
URL:
https://example.brightidea.com/api3/profileImage/8B3E8DFF-83B3-403D-BB69-28223F418676
{ "message": "success", "code": 200 }