Needio.Services

<back to all web services

GetUserInfoByUserNameRequest

The following routes are available for this service:
All Verbs/User/GetUserInfoByUserName/
GetUserInfoByUserNameRequest Parameters:
NameParameterData TypeRequiredDescription
UserNamequerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
GetUserInfoResponse Parameters:
NameParameterData TypeRequiredDescription
UserformUserInfoNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
UserInfo Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
FirstNameformstringNo
UserFullNameformstringNo
SurnameformstringNo
NickNameformstringNo
ProfileImageformMediaDTONo
UserSocialInfoformUserSocialInfoDTONo
AvatarformstringNo
MediaDTO Parameters:
NameParameterData TypeRequiredDescription
MediaIdformint?No
MediaTypeformMediaTypesNo
SourceformstringNo
MediaFileNameformstringNo
MediaMimeformstringNo
IsMainformboolNo
RefIdformint?No
OrderNumformintNo
ActionformDBActionNo
IsDeletedformboolNo
FriendlyURLformstringNo
MediaTypes Enum:
NameValue
icon0
Image1
Video2
Youtube3
Pdf8
File9
Custom10
DBAction Enum:
NameValue
None0
Insert1
Update2
Delete3
UserSocialInfoDTO Parameters:
NameParameterData TypeRequiredDescription
AvgRateformdoubleNo
RateCountformintNo
LikeCountformintNo
BanCountformintNo
BannedCountformintNo
FollowCountformintNo
FollowedCountformintNo
ActivePostCountformintNo
ViewCountformintNo
DidUserLikeformboolNo
DidUserBanformboolNo
DidUserBannedformboolNo
DidUserRateformboolNo
DidUserFollowformboolNo
DidUserFollowedformboolNo
GetUserInfoResponse Parameters:
NameParameterData TypeRequiredDescription
UserformUserInfoNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /User/GetUserInfoByUserName/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetUserInfoByUserNameRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <UserName>String</UserName>
</GetUserInfoByUserNameRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUserInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <User xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:Avatar>String</d2p1:Avatar>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:NickName>String</d2p1:NickName>
    <d2p1:ProfileImage>
      <d2p1:Action>None</d2p1:Action>
      <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:IsMain>false</d2p1:IsMain>
      <d2p1:MediaFileName>String</d2p1:MediaFileName>
      <d2p1:MediaId>0</d2p1:MediaId>
      <d2p1:MediaMime>String</d2p1:MediaMime>
      <d2p1:MediaType>icon</d2p1:MediaType>
      <d2p1:OrderNum>0</d2p1:OrderNum>
      <d2p1:RefId>0</d2p1:RefId>
      <d2p1:Source>String</d2p1:Source>
    </d2p1:ProfileImage>
    <d2p1:Surname>String</d2p1:Surname>
    <d2p1:UserFullName>String</d2p1:UserFullName>
    <d2p1:UserId>0</d2p1:UserId>
    <d2p1:UserName>String</d2p1:UserName>
    <d2p1:UserSocialInfo>
      <d2p1:ActivePostCount>0</d2p1:ActivePostCount>
      <d2p1:AvgRate>0</d2p1:AvgRate>
      <d2p1:BanCount>0</d2p1:BanCount>
      <d2p1:BannedCount>0</d2p1:BannedCount>
      <d2p1:DidUserBan>false</d2p1:DidUserBan>
      <d2p1:DidUserBanned>false</d2p1:DidUserBanned>
      <d2p1:DidUserFollow>false</d2p1:DidUserFollow>
      <d2p1:DidUserFollowed>false</d2p1:DidUserFollowed>
      <d2p1:DidUserLike>false</d2p1:DidUserLike>
      <d2p1:DidUserRate>false</d2p1:DidUserRate>
      <d2p1:FollowCount>0</d2p1:FollowCount>
      <d2p1:FollowedCount>0</d2p1:FollowedCount>
      <d2p1:LikeCount>0</d2p1:LikeCount>
      <d2p1:RateCount>0</d2p1:RateCount>
      <d2p1:ViewCount>0</d2p1:ViewCount>
    </d2p1:UserSocialInfo>
  </User>
</GetUserInfoResponse>