Field Reports

method: searchFieldReports

This API operation returns the field reports of the users based on the properties passed in.

URL / Endpoint

GET /v1/search/searchFieldReports

Request

PropertyTypeDescription
UserID integer The User ID of the AdultWork.com member profile you wish the API to return.
Nickname string The nickname of the AdultWork.com member profile you wish the API to return. Returns partial marching results
GenderID integer The ID of the gender. See the getGenders method.
ReportID integer The id of the field report.
CreatedDateFrom datetime The start date of which the field report was created. Format is yyyy-MM-dd
CreatedDateTo datetime The end date of which the field report was created. Format is yyyy-MM-dd
MeetDateFrom datetime The end date of which the meeting took place. Format is yyyy-MM-dd
MeetDateTo datetime The end date of which the meeting took place. Format is yyyy-MM-dd
InCall boolean If set to true, the field reports which was an in call will be returned.
OutCall boolean If set to true, the field reports which was an out call will be returned.
Recommended boolean If set to true, the field reports which was recommended will be returned.
VisitAgain boolean If set to true, the field reports where the user has set the will visit again option are returned.
MinReports integer The minimum amount of field reports the user has received.
CountryID integer Returns profiles from the Country to which CountyID relates. See the getCountries method.
RegionID integer Returns profiles from the Region to which RegionID relates. See the getRegions method.
CountyID integer Returns profiles from the County to which CountyID relates. See the getCounties method.
OrderBy string Sets the order in which the field reports will be returned. Default is createdate. Order options are meetdate, nickname and rating.
PageSize integer Sets the number of field reports on each page of the result set. Accepts values from 1 to 100. Default it 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

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/searchFieldReports
  ?apiKey={your-api-key}
  &UserID=123456

POST method

POST https://api-sandbox.adultwork.com/v1/search/searchFieldReports HTTP/1.1
Host: api-sandbox.adultwork.com
Content-Length: 77
Accepts: application/json
Content-Type: application/json
X-ApiKey: {your-api-key}
{"UserID":123456}
            
curl -v https://api-sandbox.adultwork.com/v1/search/searchFieldReports \
-H "Content-Type:application/json" \
-H "X-Api-Key: {your-api-key}" \
-d '{
  "UserID":123456
}' 

Response

PropertyTypeDescription
PageNumber integer Represents the current page number.
PageCount integer Represents the total number of pages in the result set.
PageSize integer Represents the total number of field reports in the result set.
FieldReportsTotal integer Represents how many field reports are listed on each page.
FieldReports Array of aws:FieldReport List of field report data.

Response Sample

The following example shows the field reports of one user

{
"PageNumber": 1,
"PageCount": 1,
"PageSize": 1,
"FieldReportsTotal": 1,
"FieldReports": [
{
"ReportID": 1,
"User": {
"UserID": 123456,
"Nickname": "
JosepheneBlogs",
"IsEscort": true,
"IsWebcam": false,
"IsPhoneChat": false,
"IsSMSChat": true,
"AvailableTodayEscort": false,
"AvailableNowWebcam": true,
"AvailableNowPhoneChat": true,
"Ratings": {
"Total": 21,
"Positive": 21,
"Neutral": 4,
"Negative": 0,
"Ratings": 29,
"Disputes": 4
},
"CountryID": 158,
"RegionID": 12,
"CountyID": 172
},
"Client": {
"UserID": 1234567,
"Nickname": "
JosepheneClient"
},
"MeetLocation": "Guildford",
"MeetDate": "2015-03-27T00:00:00",
"MeetDuration": "1 hour(s)",
"MeetFee": "£100",
"InCall": false,
"OutCall": true,
"VisitAgain": false,
"Recommend": true,
"ValueForMoney": "Good",
"Score": 2.6,
"CreatedDate": "2015-03-28T12:42:50.12"
}
]
}
<FieldReportSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.FieldReport">
<FieldReports>
<FieldReportItem>
<Client>
<Nickname>
JosepheneClient</Nickname>
<UserID>1234567</UserID>
</Client>
<CreatedDate>2015-03-28T12:42:50.12</CreatedDate>
<InCall>false</InCall>
<MeetDate>2015-03-27T00:00:00</MeetDate>
<MeetDuration>1 hour(s)</MeetDuration>
<MeetFee>£100</MeetFee>
<MeetLocation>Guildford</MeetLocation>
<OutCall>true</OutCall>
<Recommend>true</Recommend>
<ReportID>18</ReportID>
<Score>2.60</Score>
<User>
<AvailableNowPhoneChat>true</AvailableNowPhoneChat>
<AvailableNowWebcam>true</AvailableNowWebcam>
<AvailableTodayEscort>false</AvailableTodayEscort>
<CountryID>158</CountryID>
<CountyID>172</CountyID>
<IsEscort>true</IsEscort>
<IsPhoneChat>false</IsPhoneChat>
<IsSMSChat>true</IsSMSChat>
<IsWebcam>false</IsWebcam>
<Nickname>
JosepheneBlogs</Nickname>
<Ratings xmlns:d5p1="http://schemas.datacontract.org/2004/07/API.Models.Profile">
<d5p1:Disputes>4</d5p1:Disputes>
<d5p1:Negative>0</d5p1:Negative>
<d5p1:Neutral>4</d5p1:Neutral>
<d5p1:Positive>21</d5p1:Positive>
<d5p1:Ratings>29</d5p1:Ratings>
<d5p1:Total>21</d5p1:Total>
</Ratings>
<RegionID>12
</RegionID>
<UserID>123456</UserID>
</User>
<ValueForMoney>Good</ValueForMoney>
<VisitAgain>false</VisitAgain>
</FieldReportItem>
</FieldReports>
<FieldReportsTotal>1</FieldReportsTotal>
<PageCount>1</PageCount>
<PageNumber>1</PageNumber>
<PageSize>1</PageSize>
</FieldReportSearchResult>