<?xml version="1.0" encoding="UTF-8" ?>
<?xml-stylesheet type="text/xsl" href="../notes.xsl"?>
<Documentation>
	<Title code="0135">AddressBookRemoveEntries</Title>
	<Overview>
		<p>Schema used to remove entries from the user's address book. 
      This method improves on 
      <a href="./0130_documentation.xml">0130_RequestAddressBookRemoveEntry</a>
      by processing the removals in bulk resulting in a faster throughput. This method will remove all entries
      that meet the provided criteria, that exist on the system and that the account has valid permission to remove.
    </p>
	</Overview>
	<Request schema="0135_RequestAddressBookRemoveEntries.xsd">
		<p>The 'UserID' and 'Password' elements identify the account.
			The 'ServiceName' element must be set to 'AddressBookRemoveEntries'.
			The 'SoftwareVersion' element is for internal 2SMS use only and should not be set.</p>
    <p>The 'ServiceDetail' element has a 'removeAll' attribute that can be used to alter the behaviour of the method.
      If 'removeAll' is set to TRUE the method will remove ALL address book entries in the users address book that the user has
      permission to remove. If any personnumbers are provided when the 'removeAll' attribute is set to TRUE they will be
      excluded from the list to be deleted. If 'removeAll' is FALSE the method will only remove the personnumbers specified 
      in the 'ServiceDetail' element. The 'removeAll' attribute is defaulted to FALSE when not specified.</p>
		<p>The 'ServiceDetail' element can contain a 'PersonNumbers' element which contains a list of PersonNumber elements.
      Each 'PersonNumber' element is an address book contacts to be removed or excluded depending on the 'removeAll' 
      attributes value.
			(Person Numbers may be retrieved using method code <a href="./0110_documentation.xml">0110</a>.)</p>
	</Request>
	<Response schema="0910_ResponseStandard.xsd">
		<p>This method returns a successful "00/OK" response if there were no issues in removing address book entries.
      The number of contacts removed successfully will be returned.
			The 'Result' element confirms the number removed.</p>
	</Response>
</Documentation>