Cloud Fax and Notifications API 2.5 - AddressBlockRetrieve

Cloud Fax and Notifications API 2.5 Documentation
AddressBlockRetrieve

Cloud Fax and Notifications API Forums Home

prev next Table of Contents AddressBlockRetrieve

These pages describe an earlier version of the Cloud Fax and Notifications API.
While that version continues to function, new development should use the current version.

6.3 AddressBlockRetrieveResult

AddressBlockRetrieve Overview AddressBlockRetrieveRequest

Tag Name & type					#	Description
AddressBlockRetrieveResult						Namespace of this element is http://ws.easylink.com/AddressBlockRetrieve/2011/01
	Status StatusType				1	Status of processing. See StatusType.
	SubmitId xs:string				0-1	Echoes the SubmitId in the request, if one was provided, and if possible.
	BlockStore BlockStoreType				0-1	Echoes the BlockStore in the request if possible.
	NumToRetrieve xs:integer				0-1	The number of records retrieved. If the requested NumToRetrieve was greater than the TotalCount value, this value will be the same as TotalCount.
	TotalCount xs:integer				0-1	The total number of records that matched the request criteria.
	BlockRetrieveList BlockRetrieveListType				0-	Contains all the records retrieved based on the provided request criteria.
		@blockLevel BlockLevelType			0-1	The level at which the requested blocks are effective. Legal values are: user customer group (not currently supported) system (not currently supported)
		BlockRetrieveInfo BlockRetrieveInfoType			0-	Each BlockRetrieveInfo contains one block record.
			DomainBlockAddress xs:string		1	Contains a domain block record (e.g. somewhere.com). Only applies to internet addresses.
			BlockAddress BlockDestinationType		1	This element holds the actual address (e.g. the phone number for a fax address). See BlockDestinationType.
			BlockedTime xs:dateTime		0-1	Time record was entered.
			Protected xs:boolean		0-1	"true" indicates that the record is protected, i.e. it will not appear in a removal report. Default is "false".
			Cref xs:string		0-1	Customer reference number (intended for use only when block was record created based on a job)
			JobNo xs:string		0-1	Job number (intended for use only when block was record created based on a job)
			ItemRef xs:string		0-1	"ref" value of the destination (intended for use only when block was record created based on a job)
			Reason xs:string		0-1	Reason, if any, provided when the block record was created
			BlockProperty BlockExtensionType		0-	This element is used for other elements of the block record
				@key xs:string	1	This is the name of the additional element. Currently, this may be Operator CountryCode (only applicable to ANI address type)

prev next Table of Contents AddressBlockRetrieve

This information is subject to change. Please check frequently for updates.
Modified October 06, 2020