Overview
Adding note to user
Adding note to user
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/user/{userId}/note/add.html?token=XXXXXXXX&userId={userId}
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/user/{userId}/note/add.html?token=XXXXXXXX&userId={userId}
Arguments
| clientId required |
MobiWork assigned unique ID of the company |
| versionNumber required |
Version number of MobiWork API SDK release. Current version is: 10.0.78 |
| token required |
Part of URL as a request parameter and is required in every call to verify access to API calls |
| userId required |
The identifier of the user to be updated |
| userId optional |
If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID |
Return
Returns a note added success message if valid arguments are provided. Returns an error if not a valid request
Returns a note added success message if valid arguments are provided. Returns an error if not a valid request
Request Body XSD
Response Body XSD
Curl Example
| HTTP Method: | GET |
| Request: | curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/user/3199007/document/add.html?token=COJL8X2FKSLMMRTYCH2B" -data '<request> <description>Testing: new note to wo thru api</description> <visibleTouser>false</visibleTouser> </request>' |
| Response: | <?xml version="1.0" encoding="UTF-8" ?><response version="5.0.61" statusCode="1">Note added to user (3199007) successfully</response> |