WEBIndividualUpdate
Initial Build |
2008.01 |
xWEB |
Web Method |
Response Type |
Boolean |
The WEBIndividualUpdate web method updates an Individual.
Parameters
The request contains the following required parameter:
Name | Type | Occurs | Notes |
---|---|---|---|
oFacadeObject | IndividualType | 0(R)..1 | The Individual to update. |
Response
Boolean. If no error occurs during the update, the return value will will be true, confirming that the database now has the same data as the object passed to the method. If an error occurs, that will be returned as an xWebException fault or false will be returned.
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualUpdate>
<ns:oFacadeObject>
[[IndividualType]]
</ns:oFacadeObject>
</ns:WEBIndividualUpdate>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>6e9b1f2e-a3ab-4a8f-8590-534c9ff54406</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBIndividualUpdateResponse xmlns="http://www.avectra.com/2005/">
<WEBIndividualUpdateResult>true</WEBIndividualUpdateResult>
</WEBIndividualUpdateResponse>
</soap:Body>
</soap:Envelope>
Adding a Change Reason
In some cases, you might want to add a change reason to the address record, to show why the address change occurred. To do this, locate the Address_Change_Log node in the record and set the following keys to the appropriate values for the change reason:
- acl_adn_key
- acl_adr_key
- acl_cst_key
Note: The values specified are the keys, not the code values.
Recommendations
It is recommended that you first load an individual by calling WEBIndividualGet which returns an IndividualType containing all the data about that Individual. Next, update the values of any elements that need to change, and then pass that modified IndividualType back to xWeb in this method. Any value included which is different from the value in the database will be updated (for non-read-only elements).
Alternately, you could create an IndividualType containing only the elements that you want to update. This approach will result in a smaller request.