AssociatedPeopleRemove (Method)

Description

This method allows the user to remove an association from a specified person.

Request (AssociatedPeopleRemove)

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

Request Body Parameters

Name

Description

Data 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

This is an internal CoreOne AssociatedPerson id. This is the association the user wishes to be removed.

These can be retrieved through using the AssociatedPeopleIndex (Method).

xml:int

Response (AssociatedPeopleRemove_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

Name	Description	Data Type
status	If the Person Association was successfully removed a message "Remove Successful." will be returned. If however the Person Association was not successfully removed a message "Remove Failed." will be returned.	xml:string

Remarks