RHP_API

<back to all web services

GetUserGalleryAccess

Requires Authentication
The following routes are available for this service:
GET/User/Photo/Gallery/{GalleryID}/Access
GetUserGalleryAccess Parameters:
NameParameterData TypeRequiredDescription
GalleryIDpathintNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
UserGalleryAccessList Parameters:
NameParameterData TypeRequiredDescription
PhotoFolderIDformintNo
TotalCountformlongNo
ProfilesformList<ProfileSummary>No
ProfileSummary Parameters:
NameParameterData TypeRequiredDescription
MemberIDformlongNo
UserNameformstringNo
MemberTypeformshortNo
MemberTypeTitleformProfileMemberTypeNo
Age1formintNo
Age2formintNo
AgeTitleformstringNo
LocationformstringNo
MatchingInterestsformintNo
MainPhotoformProfilePhotoNo
IsOnlineformboolNo
MemberLevelformintNo
IsDiamondformboolNo
CountryIDformintNo
UserTypeformLoginUserTypeNo
MemberLevelTypeformstringNo
IsAdminformboolNo
MemberLevelUserProfileformMemberLevelUserProfileNo
IsViewableformboolNo
ProfileMemberType Parameters:
NameParameterData TypeRequiredDescription
AbbrformstringNo
SingularformstringNo
PluralformstringNo
ProfilePhoto Parameters:
NameParameterData TypeRequiredDescription
PhotoIDformintNo
HeightformintNo
WidthformintNo
ImageTypeformProfileImageTypeNo
IsPublicformboolNo
ClassificationformintNo
UserTypeformLoginUserType?No
ShowSafeModeformboolNo
ImageActionTypeformImageActionTypeNo
GalleryIDformintNo
IsAcceptedformbool?No
MemberLikeCountformintNo
IsLikedformboolNo
SortNumberformintNo
ProfilePhotoUrl Parameters:
NameParameterData TypeRequiredDescription
ThumbUrlformstringNo
FullUrlformstringNo

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.

GET /User/Photo/Gallery/{GalleryID}/Access HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserGalleryAccessList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <PhotoFolderID>0</PhotoFolderID>
  <Profiles xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:ProfileSummary>
      <d2p1:Age1>0</d2p1:Age1>
      <d2p1:Age2>0</d2p1:Age2>
      <d2p1:AgeTitle>String</d2p1:AgeTitle>
      <d2p1:CountryID>0</d2p1:CountryID>
      <d2p1:IsAdmin>false</d2p1:IsAdmin>
      <d2p1:IsDiamond>false</d2p1:IsDiamond>
      <d2p1:IsOnline>false</d2p1:IsOnline>
      <d2p1:IsViewable>false</d2p1:IsViewable>
      <d2p1:Location>String</d2p1:Location>
      <d2p1:MainPhoto>
        <d2p1:FullUrl>String</d2p1:FullUrl>
        <d2p1:ThumbUrl>String</d2p1:ThumbUrl>
        <d2p1:Classification>0</d2p1:Classification>
        <d2p1:GalleryID>0</d2p1:GalleryID>
        <d2p1:Height>0</d2p1:Height>
        <d2p1:ImageActionType>ShowImage</d2p1:ImageActionType>
        <d2p1:ImageType>None</d2p1:ImageType>
        <d2p1:IsAccepted>false</d2p1:IsAccepted>
        <d2p1:IsLiked>false</d2p1:IsLiked>
        <d2p1:IsPublic>false</d2p1:IsPublic>
        <d2p1:MemberLikeCount>0</d2p1:MemberLikeCount>
        <d2p1:PhotoID>0</d2p1:PhotoID>
        <d2p1:ShowSafeMode>false</d2p1:ShowSafeMode>
        <d2p1:SortNumber>0</d2p1:SortNumber>
        <d2p1:UserType>General</d2p1:UserType>
        <d2p1:Width>0</d2p1:Width>
      </d2p1:MainPhoto>
      <d2p1:MatchingInterests>0</d2p1:MatchingInterests>
      <d2p1:MemberID>0</d2p1:MemberID>
      <d2p1:MemberLevel>0</d2p1:MemberLevel>
      <d2p1:MemberLevelType>String</d2p1:MemberLevelType>
      <d2p1:MemberLevelUserProfile>Guest</d2p1:MemberLevelUserProfile>
      <d2p1:MemberType>0</d2p1:MemberType>
      <d2p1:MemberTypeTitle>
        <d2p1:Abbr>String</d2p1:Abbr>
        <d2p1:Plural>String</d2p1:Plural>
        <d2p1:Singular>String</d2p1:Singular>
      </d2p1:MemberTypeTitle>
      <d2p1:UserName>String</d2p1:UserName>
      <d2p1:UserType>General</d2p1:UserType>
    </d2p1:ProfileSummary>
  </Profiles>
  <TotalCount>0</TotalCount>
</UserGalleryAccessList>