Cloud Fax and Notifications API 2.5 - ProfileRead

Cloud Fax and Notifications API 2.5 Documentation
ProfileRead

Cloud Fax and Notifications API Forums Home

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.

44.3 ProfileReadResult

ProfileRead Overview ProfileReadRequest

Tag Name & type				#	Description
ProfileReadResult					Namespace of this element is http://ws.easylink.com/ProfileRead/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.
	ProfileHierarchy ProfileHierarchyType			0-1	Contains information about entities above the requested level.
		ProfileLevel ProfileLevelType		1	The entity level (user, group, customer) being described at this level of the hierarchy
		ProfileEntityId xs:integer		1	The entity id number (user account number, group entity number, customer account number) for this entity.
		ProfileEntityName ProfileEntityNameType		0-1	The associated entity name, if any. Note that although group and customer entities may have names, only user entity names are usable as entity identifiers in read and update requests. For the user level, this element will contain the userid.
			@aliasType xs:string	0-1	This attribute would be used if the value of the ProfileEntityName is a user alias. Currently, no aliases are returned here (user ids are returned for user level), so this attribute should not appear.
		ParentEntity ProfileHierarchyType		0-1	Parent entity details of the profile here. This has the same child elements as ProfileHierarchy, allowing higher entities to be recursively represented.
	ProfileItem ProfileItemType			0-	Each profile field is returned in a ProfileItem.
		ProfileLevel ProfileLevelType		1	The level at which this item is set.
		ProfileEntityId xs:integer		0-1	The entity id for which the value is set (may not be populated - information from the ProfileHierarchy may be used instead.)
		ProfileEntityName ProfileEntityNameType		0-1	The entity name for which the value is set (may not be populated - information from the ProfileHierarchy may be used instead.)
			@aliasType xs:string	0-1	This attribute would be used if the value of the ProfileEntityName is a user alias. Currently, no aliases are returned here (user ids are returned for user level), so this attribute should not appear.
		ProfileItemName xs:string		1	Profile item name.
		ProfileItemValue xs:string		1	Profile item value.
		ProfileFieldInfo ProfileFieldInfoType		0-1	Describes the data format for the profile item. This optional detail information is only provided if ReturnFieldInfo in the request is "true".
			ProfileItemFormat xs:string	1	A description of the content format of the profile item.s data. Possible values for this element are: integer string enumeration blackoutWindow dateTime
			ProfileEnumValue xs:string	0-	List of one or more valid values that may be used for this field. This collection exists only if the ProfileItemFormat is "enumeration"

prev next Table of Contents ProfileRead

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