People Web Service
MethodPeopleMakeInactive
Description
This method allows the user to make a specified CoreOne Person inactive.
Request (PeopleMakeInactive)

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

Request Body Parameters

NameDescriptionData Type
token

This is a 40-character hexadecimal string.

This token should have been obtained at the commencement of a session using the Login (Method). It is required for all functional CoreOne web services.
xml:string
id

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

These can be retrieved through using the PeopleIndex (Method).
xml:int
Response (PeopleMakeInactive_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 made inactive a message "Update successful." will be returned. If however the person was not successfully made inactive a message "Update Failed." will be returned.xml:string
Remarks

See Also
All Operations Resource GroupPeople Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.