Search Rentals

This API operation returns the rental movies used in AdultWork.com.

URL / Endpoint

GET /v1/search/searchRentals

Request

Property	Type	Description
`UserID`	integer	Returns all rental movies of the profile with the specified UserID.
`GroupID`	integer	Returns all rental movies of the members of the group with the specified GroupID.
`MinSize`	big integer	The minimum size of the file in bytes.
`MaxSize`	big integer	The maximum size of the file in bytes.
`MinDuration`	integer	The minimum duration of the movie in seconds.
`MaxDuration`	integer	The maximum duration of the movie in seconds.
`Keywords`	string	Returns rental movies which `Description` or `Title` contains the keyword supplied.
`Nickname`	string	Returns rental movies of owners of the nickname supplied.
`AspectRatio`	string	Returns rental movies of the specified aspect ratio. See the getAspectRatio method.
`Uploaded`	integer	The amount of days ago the movie was uploaded.
`IsAmateur`	boolean	If set to `true` the rental movies are returned which have the amateur set to true.
`IsProfessional`	boolean	If set to `true` the rental movies are returned which have the professional set to true.
`HasThumbnail`	boolean	If set to `true` the movies are returned which have a thumbnail.
`IsEscort`	boolean	If set to `true` the rental movies returned belongs to members that offer Escort services. Note that money paid to escorts on AdultWork.com is for their time and companionship only. Whatever else occurs if and when contact is made is the choice of consenting adults.
`IsWebCam`	boolean	If set to `true` the rental movies returned belongs to members that offer Webcam services.
`IsPhoneChat`	boolean	If set to `true` the rental movies returned belongs to members that offer Phone Chat / Phone Sex services.
`GenderID`	integer	The movies returned belongs to members that are of the gender supplied. See the getGenders method.
`MinAge`	integer	The movies returned belongs to members that have a minimum age (in years) of the supplied value, calculated from their supplied Date of Birth. All members are 18+ years of age.
`MaxAge`	integer	The movies returned belongs to members that have a maximum age (in years) of the supplied value, calculated from their supplied Date of Birth. All members are 18+ years of age.
`Ethnicity`	string	Returns movies of owners that are have this ethnicity. See the getEthnicity method.
`DressSize`	string	Returns movies of owners that are have this dress size. See the getDressSizes method.
`BustSize`	string	Returns movies of owners that are have this bust size. See the getBustSizes method.
`VATIPAddress`	string	If supplied it will check the country of that IP address and add the local VAT to the price. For example: IP addresses from the UK will add `20 %` to the price.
`VATUserID`	integer	If supplied it will overrule `VATIPAddress`. It will get the users vat details and add the vat to the price.
`OrderBy`	string	Sets the order in which the movies will be returned. Default is size. Order options are `price`, `nickname` and `dateuploaded`.
`CategoryIDs`	string	Comma delimited string of CategoryIDs. Categories to which the IDs pertain will be included. For example `1,2,3`. See the getMovieCategories method.
`MoviesPerPageSize`	integer	Sets the number of rental movies 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.

This endpoint has the following optional headers:

Headers	Value
`X-MaskImages`	`1`	What's this?

Authentication

Your API-Key is required with every request and can be passed in as a header or a query-string parameter. Don't have an API-Key? Get one now.

Samples

GET method

https://api-sandbox.adultwork.com/v1/search/searchRentals
  ?apiKey={your-api-key}

Response

Property	Type	Description
`PageCount`	integer	Represents the total number of pages in the result set.
`PageNumber`	integer	Represents the current page number.
`MoviesTotal`	integer	Represents the total number of rental movies in the result set.
`MoviesPerPage`	integer	Represents how many rental movies are listed on each page.
`MovieCategories`	Array of aws:MovieCategoryCount	List categories with the amount of the search result.
`Movies`	Array of aws:RentalMovie	List of rental movies data.

Response Sample

The following example returns an example result of the rental movies listed on AdultWork.com.

JSON
XML

{
  "PageCount": 1,
  "PageNumber": 1,
  "MoviesTotal": 1,
  "MoviesPerPage": 1,
  "MovieCategories": [
    {
      "CategoryID": 1,
      "CategoryName": "A Levels",
      "Count": 1
    }
  ],
  "Movies": [    
  {
  "MovieID": "123456789",
  "Title": "Boat Fun",
  "Details": "A lot of fun on the boat",
  "ThumbSafe": false,
  "ThumbURL": "https://rentals.adultwork.com/E/SS/T/1.jpg",
  "ImageSafe": false,
  "ImageURL": "https://rentals.adultwork.com/E/SS/I/1.jpg",
  "Credits": 1.20,
  "Seconds": 3661,
  "Size": 349622123,
  "IsAmateur": false,
  "IsProfessional": false,
  "AspectRatio": "16:9",
  "Width": 640,
  "Height": 352,
  "DateUploaded": "2015-07-30T15:40:16.117",
  "Rating": 66.36,  
  "ImagesSafe": false,
  "Images": [
        {
          "URL": "//rentals.adultwork.com/E/ASS/I/1.jpg"
        }  
    ]
  "Categories": [
    {
      "CategoryID": 1,
      "CategoryName": "A Levels"
    }
  ],
  "Prices": [
    {
      "DurationID": 1,
      "DurationDays": 1,
      "IsUnlimited": false,
      "Price": 3.99
    },
    {
      "DurationID": 2,
      "DurationDays": 7,
      "IsUnlimited": false,
      "Price": 5.99
    },
    {
      "DurationID": 3,
      "DurationDays": 364,
      "IsUnlimited": true,
      "Price": 9.99
    }
  ],
  "User": {
    "RentalCount": 7,
    "GenderID": 2,
    "ProfileThumbnailSafe": false,
    "ProfileThumbnailURL": null,
    "ProfileURL": 
"http://refer.adultwork.com/?PID=1&T=http%3a%2f%2fwww.adultwork.com%2f123456",    "RatingsURL": 
"http://refer.adultwork.com/?PID=1&T=http%3a%2f%2fwww.adultwork.com%2fdlgExtRatings.asp%3fU%3d123456",  
    "UserID": 123456,
    "Nickname": "JosepheneBlogs",
    "IsEscort":true,
    "IsWebcam":false,
    "IsPhoneChat":false,
    "IsSMSChat":false,
    "AvailableTodayEscort": true,
    "AvailableNowWebcam": false,
    "AvailableNowPhoneChat": false,
    "Age": 21,
    "Ratings":{
        "Total":33,
        "Positive":34,
        "Neutral":0,
        "Negative":1,
        "Ratings":35,
        "Disputes":0
        }
      }
    }
  ]
}

<MovieSearchRentalResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Movies">
    <MovieCategories>
        <MovieCategoryCount>
            <CategoryID>1</CategoryID>
            <CategoryName>A Levels</CategoryName>
            <Count>1</Count>
        </MovieCategoryCount>
    <MovieCategories>
    <Movies>
        <RentalResult>
            
 <MovieID>123456789</MovieID>
    <Title>Boat Fun</Title>
    <Details>A lot of fun on the boat</Details>
    <ThumbSafe>false</ThumbSafe>
    <ThumbURL>https://rentals.adultwork.com/E/SS/T/1.jpg</ThumbURL>
    <ImageSafe>false</ImageSafe>
    <ImageURL>https://rentals.adultwork.com/E/SS/I/1.jpg</ImageURL>
    <Seconds>3661</Seconds>
    <Size>349622123</Size>
    <IsAmateur>false</IsAmateur>
    <IsProfessional>false</IsProfessional>
    <AspectRatio>16:9</AspectRatio>
    <Width>640</Width>
    <Height>352</Height>
    <DateUploaded>2015-07-30T15:40:16.117</DateUploaded>
    <Rating>0</Rating>
    <ImagesSafe>false</ImagesSafe>
    <Images>
        <RentalImages>
            <URL>//rentals.adultwork.com/E/ASS/I/1.jpg</URL>
        </RentalImages>
    </Images>
    <Categories>
        <MovieCategories>
            <CategoryID>1</CategoryID>
            <CategoryName>A Levels</CategoryName>
        </MovieCategories>        
    </Categories>
    <Prices>
        <RentalDuration>
            <DurationDays>1</DurationDays>
            <DurationID>1</DurationID>
            <IsUnlimited>false</IsUnlimited>
            <Price>3.9900</Price>
        </RentalDuration>
        <RentalDuration>
            <DurationDays>7</DurationDays>
            <DurationID>2</DurationID>
            <IsUnlimited>false</IsUnlimited>
            <Price>5.9900</Price>
        </RentalDuration>
        <RentalDuration>
            <DurationDays>364</DurationDays>
            <DurationID>3</DurationID>
            <IsUnlimited>true</IsUnlimited>
            <Price>9.9900</Price>
        </RentalDuration>
    </Prices>
    <User>
        <Age xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">34</Age>
        <AvailableNowPhoneChat xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">true</AvailableNowPhoneChat>
        <AvailableNowWebcam xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">false</AvailableNowWebcam>
        <AvailableTodayEscort xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">false</AvailableTodayEscort>
        <IsEscort xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">true</IsEscort>
        <IsPhoneChat xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">false</IsPhoneChat>
        <IsSMSChat xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">false</IsSMSChat>
        <IsWebcam xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">false</IsWebcam>
        <Nickname xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">DirectCam</Nickname>
        <Ratings xmlns:d3p1="http://schemas.datacontract.org/2004/07/API.Models.Profile" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">
            <d3p1:Disputes>0</d3p1:Disputes>
            <d3p1:Negative>1</d3p1:Negative>
            <d3p1:Neutral>0</d3p1:Neutral>
            <d3p1:Positive>34</d3p1:Positive>
            <d3p1:Ratings>35</d3p1:Ratings>
            <d3p1:Total>33</d3p1:Total>
        </Ratings>
        <UserID xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">191</UserID>
        <GenderID>3</GenderID>
        <ProfileThumbnailURL>http://refer.adultwork.com/?PID=1&T=http%3a%2f%2fwww.adultwork.com%2f123456</ProfileThumbnailURL>
        <ProfileURL>http://refer.adultwork.com/?PID=1&amp;T=http%3a%2f%2fwww.adultwork.com%2f191</ProfileURL>
        <RatingsURL>http://refer.adultwork.com/?PID=1&T=http%3a%2f%2fwww.adultwork.com%2fdlgExtRatings.asp%3fU%3d123456</RatingsURL>
        <RentalCount>4</RentalCount>
    </User>
    <Rating>66.36</Rating>
    <Images>
        <RentalImages>         <URL>//rentals.adultwork.com/E/ASS/I/1.jpg</URL>
        </RentalImages>
    <Images>
        </RentalResult>
    </Movies>
    <MoviesPerPage>1</MoviesPerPage>
    <MoviesTotal>1</MoviesTotal>
    <PageCount>1</PageCount>
    <PageNumber>1</PageNumber>
</MovieSearchResult>