Get HotListPopular

This API operation returns an array of members the logged in user had interaction with.

URL / Endpoint

GET /v1/HotLists/GetHotListPopular

Request

Property	Type	Description
`OrderBy`	string	Sets the order in which the members will be returned. Default is `interactioncount-asc`. Order options are `interactioncount-asc`, `interactioncount-desc`, `lastinteractiondate-asc`, `lastinteractiondate-desc`, `username-asc` and `username-desc`.
`ProfilesPerPage`	integer	Sets the number of profiles on each page of the result set. Accepts values from 1 to 100. Default is `50`.
`PageNumber`	integer	Returns a specific page in the result set. Accepts values from `1` onwards.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

Authentication

An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.

Scopes

This endpoint requires the following scope:

Scope
`profile_hotlist`

Samples

GET method

https://api-sandbox.adultwork.com/v1/HotLists/GetHotListPopular

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`PageCount`	integer	Represents the total number of pages in the result set.
`PageNumber`	integer	Represents the current page number.
`ProfilesPerPage`	integer	Represents how many profiles are listed on each page.
`ProfilesTotal`	integer	Represents the total number of profiles in the result set.
`Profiles`	Array of aws:HotListProfile	List of profiles.

Response Sample

The following example shows a sample hotlist returned by the API.

JSON
XML

{
  "PageNumber": 1,
  "PageCount": 1,
  "ProfilesPerPage": 1,
  "ProfilesTotal": 1,
  "Profiles": [
   {
      "UserID": 123456,
      "Nickname": "JosepheneBlogs",
      "Age": 21,
      "GenderID": 2,
      "IsTVTS": false,
      "Ratings": {
        "Total": 33,
        "Positive": 34,
        "Neutral": 0,
        "Negative": 1,
        "Ratings": 35,
        "Disputes": 0
      },
      "IsEscort": true,
      "IsWebcam": false,
      "IsPhoneChat": false,
      "IsSMSChat": true,
      "IsDirectCam": false,
      "IsDirectIM": false,
      "AvailableTodayEscort": false,
      "AvailableNowWebcam": true,
      "AvailableNowPhoneChat": true,
      "DirectCam": null,
      "LastInteractionDate": "2016-09-16T16:00:02.137",
      "InteractionCount": 1,
      "ListName": null,
      "ListID": null
    }  
  ]
}

<HotlistPopularOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.HotLists">
  <PageCount>1</PageCount>
  <PageNumber>1</PageNumber>
  <Profiles>
  <HotListProfile>
  <Age>21</Age>
  <AvailableNowPhoneChat>true</AvailableNowPhoneChat>
  <AvailableNowWebcam>true</AvailableNowWebcam>
  <AvailableTodayEscort>false</AvailableTodayEscort>
  <DirectCam xmlns:d4p1="http://schemas.datacontract.org/2004/07/API.Models.Profile" i:nil="true" />
  <GenderID>2</GenderID>
  <InteractionCount>1</InteractionCount>
  <IsDirectCam>false</IsDirectCam>
  <IsDirectIM>false</IsDirectIM>
  <IsEscort>true</IsEscort>
  <IsPhoneChat>false</IsPhoneChat>
  <IsSMSChat>true</IsSMSChat>
  <IsTVTS>false</IsTVTS>
  <IsWebcam>false</IsWebcam>
<LastInteractionDate>2016-09-16T16:00:02.137</LastInteractionDate>
  <ListID i:nil="true" />
  <ListName i:nil="true" />
  <Nickname>JosepheneBlogs</Nickname>
  <Ratings xmlns:d4p1="http://schemas.datacontract.org/2004/07/API.Models.Profile">
  <d4p1:Disputes>0</d4p1:Disputes>
  <d4p1:Negative>1</d4p1:Negative>
  <d4p1:Neutral>0</d4p1:Neutral>
  <d4p1:Positive>34</d4p1:Positive>
  <d4p1:Ratings>35</d4p1:Ratings>
  <d4p1:Total>33</d4p1:Total>
  </Ratings>
  <UserID>123456</UserID>
  </HotListProfile>
  </Profiles>
  <ProfilesPerPage>1</ProfilesPerPage>
  <ProfilesTotal>1</ProfilesTotal>
</HotlistPopularOutput>