Overview
The http PUT method is used to update existing records. Both url-encoding and json-encoding are supported.
Return:
| Status Code | Error Code | Return | |
|---|---|---|---|
| Success | 200 | The entityID of the updated record. If no change was made to the record, the entityID is not returned. | |
| Success | 204 | No Content. This occurs when there is no change made to the record as there are no differences between the data supplied and the record. | |
| The entity cannot be udpated as it has been deleted. | 500 | ENTITY_DELETED | |
| Attempting to update an entity that does not exist. | 500 | NONEXISTENT_ENTITY |
Example:
| Method | URL | Content-Type |
|---|---|---|
| PUT |
https://<relaywareHost>/api/v1/organization/{organizationID} https://<relaywareHost>/api/v1/organizations |
application/x-www-form-urlencoded or text/json |
| HTML Example |
|---|
|
PUT https://relaywareHost/api/v1/persons HTTP/1.1 sessionID: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Content-Type: application/x-www-form-urlencoded
personid=xxxx&firstname=yyyy
OR PUT /api/v1/person/5836 HTTP/1.1 Host: <relaywareHost> sessionID: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Content-Type: text/json
{"contactuserroles":"partnersuperuser"}
OR PUT /api/v1/persons?personid=6082&contactuserroles=partnersuperuser HTTP/1.1 Host: <relaywareHost> sessionID: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Comments
0 comments
Please sign in to leave a comment.