Cloud Fax and Notifications API 2.6 Documentation
ProfileRead		Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  ProfileRead  

44.2 ProfileReadRequest

ProfileRead Overview   ProfileReadResult

Tag Name
& type		#Description
ProfileReadRequest   Namespace of this element is http://ws.easylink.com/ProfileRead/2011/01
   SubmitId
xs:string		0-1Optional string identifying request, which will be echoed in result.
   ProfileLevel
ProfileLevelType		1The level of profile information being requested - one of:
  • user
  • group
  • customer
("system" is not accepted for a ProfileReadRequest)
   ProfileEntityId
xs:integer		1The entity id number for which profile information is being requested. For user level, this must be the UserAccountNumber. For group level, this must be the GroupNo. For customer level, this must be the CustomerNumber.
ProfileEntityName
ProfileEntityNameType		1Requests for user level information may use the user id string in this value as an alternative to the ProfileEntityId. This is only available for user level requests.
This field may also identify a user using a recognized alias (similar to RequesterId) by specifing the type of alias in the aliasType attribute.
   @aliasType
xs:string		0-1If the ProfileEntityName contains an alias rather than a user id, the type of the alias must be specified using this attribute. The following alias type prefixes are supported:
  • M2F
  • F2M
  • SMS
  • MPI
  • INTERNET
  • INBOUND_FAX
  • SMS_SHORT_CODE
  • MOBILE_PHONE_ID
   ReturnFieldInfo
xs:boolean		0-1Boolean value indicating full profile item detail ("true") or minimal profile detail ("false"). Default is false.
Full detail is returned in ProfileFieldInfo.
 
    prev  next        Table of Contents  ProfileRead  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy		 This information is subject to change. Please check frequently for updates.
Modified October 06, 2020