People Web Service
MethodPeopleEdit
Description
This method allows the user to edit attributes for a specified CoreOne Person.
Request (PeopleEdit)

Below are the parameters to successfully update a CoreOne Person. If any required parameter is omitted an error message will be displayed alerting the user.

Request Body Parameters

NameDescriptionData Type
token
xml:string
id

This is an internal CoreOne Person id. This is the person the user wishes to update.

These can be retrieved through using the PeopleIndex (Method).
xml:int
personThese are the input parameters necessary for a successful edit of a Person.ws_person_c
Response (PeopleEdit_response)

This is the returned status message to tell the user the result of the method.

An error message will be displayed instead of the status message if any of the input parameters fail any validation rule. For example if the user's token is invalid or the record doesn't exist. It will alert the user on what parameter failed validation and the reason why.

Response Body Parameters

NameDescriptionData Type
statusIf the person was successfully updated a message "Update successful." will be returned. If however the person was not successfully updated a message "Update Failed." will be returned.xml:string
Example

Remarks
All data elements within the record will be updated and overwritten. Therefore any input fields left blank will overwrite any data present. 

See Also
All Operations Resource GroupPeople Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.