POST | /DateFinder/ |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SearchCriteria | body | DateFinderSearchCriteria | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Size | form | int | No | |
Page | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SeekingTypes | form | short | No | Sum of selected seeking types, API will return Dates from selected types only, if left blank or -1 all User types will be returned. |
AgeMin | form | int | No | Minimum age, defaults to User's min seeking age |
AgeMax | form | int | No | Maximum age, defaults to user's max seeking age |
GoogleMapPlaceID | form | string | No | Google location place ID, defaults to User's profile location |
SearchRadius | form | short | No | Search radius, defaults to 50km |
StartDate | form | DateTime? | No | Start date for date range search. |
EndDate | form | DateTime? | No | End date for date range search. |
CustomDate | form | DateTime? | No | Custom date will return dates starting from specified date, and will supersede Date Range. |
MeetingTypes | form | int | No | Will return dates that match the selected meeting types. |
WithPhoto | form | bool | No | Will return only users that have photos. |
CanHost | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SearchSummary | form | DateFinderSearchResultSummary | No | |
CountSummary | form | DateFinderCountSummary | No | |
SearchCriteria | form | DateFinderSearchCriteriaReturn | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Dates | form | List<DateFinderDisplayItem> | No | |
TotalSearchCount | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Profile | form | ProfileSummary | No | |
HasExpressedInterest | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | int | No | |
DateHeld | form | DateTime | No | |
DateHeldUtcIso | form | string | No | |
Comment | form | string | No | |
ShortComment | form | string | No | |
Location | form | string | No | |
City | form | string | No | |
StateName | form | string | No | |
StateNameAbbr | form | string | No | |
CountryName | form | string | No | |
AgeMin | form | int | No | |
AgeMax | form | int | No | |
SeekingTypes | form | short | No | |
OpenForList | form | List<string> | No | |
OpenForTypes | form | int | No | |
SeekingTypeList | form | LookupValue[] | No | |
CanHost | form | bool | No | |
DisplayDate | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IsMatch | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | int | No | |
Text | form | string | No | |
TextAbbr | form | string | No | |
ListID | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MemberID | form | long | No | |
UserName | form | string | No | |
MemberType | form | short | No | |
MemberTypeTitle | form | ProfileMemberType | No | |
Age1 | form | int | No | |
Age2 | form | int | No | |
AgeTitle | form | string | No | |
Location | form | string | No | |
MatchingInterests | form | int | No | |
MainPhoto | form | ProfilePhoto | No | |
IsOnline | form | bool | No | |
MemberLevel | form | int | No | |
IsDiamond | form | bool | No | |
CountryID | form | int | No | |
UserType | form | LoginUserType | No | |
MemberLevelType | form | string | No | |
IsAdmin | form | bool | No | |
MemberLevelUserProfile | form | MemberLevelUserProfile | No | |
IsViewable | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Abbr | form | string | No | |
Singular | form | string | No | |
Plural | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PhotoID | form | int | No | |
Height | form | int | No | |
Width | form | int | No | |
ImageType | form | ProfileImageType | No | |
IsPublic | form | bool | No | |
Classification | form | int | No | |
UserType | form | LoginUserType? | No | |
ShowSafeMode | form | bool | No | |
ImageActionType | form | ImageActionType | No | |
GalleryID | form | int | No | |
IsAccepted | form | bool? | No | |
MemberLikeCount | form | int | No | |
IsLiked | form | bool | No | |
SortNumber | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ThumbUrl | form | string | No | |
FullUrl | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalDateMatchingCount | form | int | No | |
TotalDates | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SuburbItem | form | SuburbItem | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PostCodeAllID | form | int | No | |
Suburb | form | string | No | |
PostCode | form | string | No | |
StateID | form | int | No | |
StateName | form | string | No | |
StateNameAbbr | form | string | No | |
CountryID | form | int | No | |
CountryName | form | string | No | |
CountryCode | form | string | No | |
GoogleMapPlacesId | form | string | No | |
Type | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /DateFinder/ HTTP/1.1
Host: tstsrvs.redhotpie.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SearchCriteria:
{
SeekingTypes: 0,
AgeMin: 0,
AgeMax: 0,
GoogleMapPlaceID: String,
SearchRadius: 0,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
CustomDate: 0001-01-01,
MeetingTypes: 0,
WithPhoto: False,
CanHost: False
},
Size: 0,
Page: 0
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { SearchSummary: { Dates: [ { Profile: { MemberID: 0, UserName: String, MemberType: 0, MemberTypeTitle: { Abbr: String, Singular: String, Plural: String }, Age1: 0, Age2: 0, AgeTitle: String, Location: String, MatchingInterests: 0, MainPhoto: { PhotoID: 0, Height: 0, Width: 0, ImageType: None, IsPublic: False, Classification: 0, UserType: General, ShowSafeMode: False, ImageActionType: ShowImage, GalleryID: 0, IsAccepted: False, MemberLikeCount: 0, IsLiked: False, SortNumber: 0, ThumbUrl: String, FullUrl: String }, IsOnline: False, MemberLevel: 0, IsDiamond: False, CountryID: 0, UserType: General, MemberLevelType: String, IsAdmin: False, MemberLevelUserProfile: Guest, IsViewable: False }, HasExpressedInterest: False, ID: 0, DateHeld: 0001-01-01, DateHeldUtcIso: String, Comment: String, ShortComment: String, Location: String, City: String, StateName: String, StateNameAbbr: String, CountryName: String, AgeMin: 0, AgeMax: 0, SeekingTypes: 0, OpenForList: [ String ], OpenForTypes: 0, SeekingTypeList: [ { IsMatch: False, Value: 0, Text: String, TextAbbr: String, ListID: 0 } ], CanHost: False, DisplayDate: String } ], TotalSearchCount: 0 }, CountSummary: { TotalDateMatchingCount: 0, TotalDates: 0 }, SearchCriteria: { SuburbItem: { PostCodeAllID: 0, Suburb: String, PostCode: String, StateID: 0, StateName: String, StateNameAbbr: String, CountryID: 0, CountryName: String, CountryCode: String, GoogleMapPlacesId: String, Type: String }, SeekingTypes: 0, AgeMin: 0, AgeMax: 0, GoogleMapPlaceID: String, SearchRadius: 0, StartDate: 0001-01-01, EndDate: 0001-01-01, CustomDate: 0001-01-01, MeetingTypes: 0, WithPhoto: False, CanHost: False } }