This action may lead to changes in the database
Do you want to continue?
Data Explorer
Web API Query String
Request Information
Get Bookmark Data by User Id (GUID), and optionally by Template Id and/or Bookmark Id.
Parameters:
- UserId
- TemplateId
- BookmarkId
- ShowNotes
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| partnerId |
Partner id |
integer |
Required |
| userId |
User Id to retrieve bookmark data records |
string |
Required |
| bookmarkId |
Optional filter by related bookmark id |
integer |
None. |
| templateId |
Optional filter by template id |
integer |
None. |
| showNotes |
Show bookmark data notes |
boolean |
Default value is False |
| showLikes |
Show likes/dislikes for image |
boolean |
Default value is False |
| bookmarkIds |
List of bookmarIds (send the parameter multiple times) |
string |
None. |
| showUserActions | boolean |
Default value is False |
|
| showImageInfo | boolean |
Default value is False |
|
| showHomeInfo | boolean |
Default value is False |
Response
×
The request was made Successfully! Check the result!.
×
Error Something happen, the Api doesn't have a response.
{
"Time": "sample string 1",
"Error": {
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
},
"ErrorMessage": "sample string 2",
"Status": "sample string 3",
"Server": "sample string 4",
"Count": 1,
"FavoriteCounts": {
"CommCount": 1,
"PlanCount": 2,
"SpecCount": 3
},
"FavoriteFacets": {
"Cities": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"PostalCodes": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"Markets": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
]
},
"Result": {
"HomeCount": 1,
"ImageCount": 2,
"BookmarkData": [
{
"Id": 1,
"Action": 1,
"UserId": "sample string 2",
"BoardOwnerUserId": "sample string 3",
"UserContent": "sample string 4",
"ContentType": 1,
"ContentId": 1,
"ContentIds": [
1,
2
],
"TemplateId": 1,
"BookmarkId": 1,
"BookmarkIds": [
1,
2
],
"Likes": 1,
"Dislikes": 1,
"Comment": "sample string 5",
"Notes": [
"sample string 1",
"sample string 2"
],
"UserActions": [
{
"UserId": "sample string 1",
"Name": "sample string 2",
"Comment": "sample string 3",
"ByOwner": true,
"Like": true
},
{
"UserId": "sample string 1",
"Name": "sample string 2",
"Comment": "sample string 3",
"ByOwner": true,
"Like": true
}
],
"ImageInfo": {
"Id": 1,
"Path": "sample string 2",
"ColorType": "sample string 3",
"Category": "sample string 4",
"Type": "sample string 5",
"Width": 1,
"Height": 1,
"Sequence": 6,
"ObjectLabels": "sample string 7"
},
"HomeInfo": {
"HomeId": 1,
"CommId": 2,
"PlanId": 3,
"ListingId": 4,
"IsBasic": true,
"CommName": "sample string 6",
"PlanName": "sample string 7",
"IsSpec": true,
"MarketId": 9,
"BuilderId": 10,
"Br": 11,
"Ba": 12,
"HBa": 13,
"St": 14,
"Gr": 15,
"Sft": 16,
"Price": 17.0,
"Addr": "sample string 18",
"City": "sample string 19",
"County": "sample string 20",
"State": "sample string 21",
"Thumb1": "sample string 22",
"Thumb2": "sample string 23",
"IntImage": "sample string 24",
"Zip": "sample string 25",
"Status": "sample string 26",
"BrandLogo": "sample string 27",
"Brand": {
"Id": 1,
"Name": "sample string 2",
"BuilderId": 1,
"Logo": "sample string 3",
"LogoSmall": "sample string 4",
"MarketId": 1,
"City": "sample string 5",
"State": "sample string 6",
"SiteUrl": "sample string 7",
"ShowCaseStatusId": 1,
"IsBasic": 8,
"HasShowCase": 9,
"TotalHome": 1,
"CommunityCount": 1,
"BoylCount": 1,
"ModularCount": 1,
"CustomCount": 1,
"CustomBuilderCount": 1,
"PlanCount": 1,
"SpecCount": 1,
"UnderConstructionCount": 1,
"GalleryCount": 1,
"ShowMortgageLink": "sample string 10",
"CustomMortgageLink": "sample string 11",
"TestimonialCount": 1,
"IsBoyl": 12,
"IsModularBuilder": 13,
"IsCustomBuilder": 14,
"IsNewCustomBuilderLocation": 15,
"Overview": "sample string 16",
"Description": "sample string 17",
"RssFeed": "sample string 18",
"TwitterWidget": "sample string 19",
"FacebookWidget": "sample string 20",
"BrandUrl": "sample string 21",
"ContactEmail": "sample string 22",
"Location": {
"Id": 1,
"DudaUrl": "sample string 2",
"CommunityNumber": "sample string 3",
"Name": "sample string 4",
"Desc": "sample string 5",
"Lat": "sample string 6",
"Lng": "sample string 7",
"SalesOfficeLat": "sample string 8",
"SalesOfficeLng": "sample string 9",
"BuilderId": 10,
"MarketId": 11,
"MarketName": "sample string 12",
"ParentId": 13,
"BrLo": 14,
"BrHi": 15,
"BaLo": 16,
"BaHi": 17,
"HBaLo": 18,
"HBaHi": 19,
"SftLo": 1,
"SftHi": 1,
"PrLo": 1,
"PrHi": 1,
"GrLow": 1.0,
"GrHi": 1.0,
"Addr": "sample string 20",
"City": "sample string 21",
"County": "sample string 22",
"State": "sample string 23",
"StateName": "sample string 24",
"Zip": "sample string 25",
"Thumb1": "sample string 26",
"Thumb2": "sample string 27",
"Thumb3": "sample string 28",
"Status": "sample string 29",
"NumHomes": 30,
"NumQmi": 31,
"NumQmiDone": 32,
"Phone": "sample string 33",
"IsTrackingNumber": true,
"SalesOfficePhone": "sample string 35",
"Amenities": [
{
"Type": "sample string 1",
"TypeCode": "sample string 2",
"Name": "sample string 3",
"Url": "sample string 4",
"Open": 5,
"Sequence": 7
},
{
"Type": "sample string 1",
"TypeCode": "sample string 2",
"Name": "sample string 3",
"Url": "sample string 4",
"Open": 5,
"Sequence": 7
}
],
"CustomAmenities": [
{
"Id": 1,
"GrpName": "sample string 2",
"Desc": "sample string 3",
"Url": "sample string 4",
"Pos": 5
},
{
"Id": 1,
"GrpName": "sample string 2",
"Desc": "sample string 3",
"Url": "sample string 4",
"Pos": 5
}
],
"SchoolDistricts": [
{
"Id": 1,
"Name": "sample string 2",
"DistrictName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"DistrictName": "sample string 3"
}
],
"Schools": [
{
"Id": 1,
"Name": "sample string 2",
"DistrictName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"DistrictName": "sample string 3"
}
],
"HasHotHomes": 36,
"HasModelHome": 37,
"IsGreen": 38,
"IsUrban": 39,
"IsGated": 40,
"IsAdult": 41,
"Nature": 42,
"Pool": 43,
"Views": 44,
"Golf": 45,
"WaterFront": 46,
"Sports": 47,
"Parks": 48,
"IsCondo": 49,
"IsTownHome": 50,
"IsAgeRest": 51,
"IsLuxury": true,
"Promo": 53,
"AgtPromo": 54,
"HasEvent": 55,
"HasVideo": 56,
"Dist": 57.1,
"IsBasic": 58,
"BuilderCount": 59,
"CommunityType": "sample string 60",
"ProjectType": "sample string 61",
"MarketingHeadline": "sample string 62",
"CommunityUrl": "sample string 63",
"ShowDevNm": true,
"IsBoyl": true,
"IsCustom": true,
"IsManufactured": true,
"NumModelsHomes": 68,
"ModelHomes": 69,
"PlansCount": 70,
"CompleteCount": 71,
"UnderConstruction": 72,
"FulfillmentCode": "sample string 73",
"PreferredScore": 1,
"Bookmarks": [
{
"Id": 1,
"UserId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Initials": "sample string 5",
"ContentTypeId": 1,
"ContentTypeName": "sample string 6",
"ContentId": 1,
"Title": "sample string 7",
"Url": "sample string 8",
"Action": "Saved",
"Ownership": "sample string 9",
"DateChanged": "2025-04-19T09:31:13.3392139-05:00",
"Notes": [
"sample string 1",
"sample string 2"
],
"SharedUsers": [
{
"UserId": "sample string 1",
"LogonName": "sample string 2",
"PartnerId": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleName": "sample string 6",
"Initials": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"PostalCode": "sample string 10",
"Address1": "sample string 11",
"Address2": "sample string 12",
"Phone": "sample string 13",
"PhoneExt": "sample string 14",
"RegMetro": "sample string 15",
"SsoId": "sample string 16",
"ImageUrl": "sample string 17",
"MoveInDate": 18,
"FinancePreference": 19,
"Reason": 20,
"AgeRange": 21,
"HomePrefence": 22,
"Password": "sample string 23",
"DateRegistered": "2025-04-19T09:31:13.3392139-05:00",
"LeadOptIn": "sample string 26",
"RegBOYLInterest": true,
"RegComingSoonInterest": true,
"RegActiveAdultInterest": true,
"WeeklyOptIn": true,
"WeeklyHomeOptIn": true,
"MarketOptIn": true,
"MailList": true,
"Bookmarks": [],
"SharedUserProfiles": [
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkOwnership": "sample string 34",
"LikedImagesCount": 1,
"BoardCount": 1,
"Boards": [],
"InvitationEmail": "sample string 35",
"LastLogon": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserId": "sample string 1",
"LogonName": "sample string 2",
"PartnerId": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleName": "sample string 6",
"Initials": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"PostalCode": "sample string 10",
"Address1": "sample string 11",
"Address2": "sample string 12",
"Phone": "sample string 13",
"PhoneExt": "sample string 14",
"RegMetro": "sample string 15",
"SsoId": "sample string 16",
"ImageUrl": "sample string 17",
"MoveInDate": 18,
"FinancePreference": 19,
"Reason": 20,
"AgeRange": 21,
"HomePrefence": 22,
"Password": "sample string 23",
"DateRegistered": "2025-04-19T09:31:13.3392139-05:00",
"LeadOptIn": "sample string 26",
"RegBOYLInterest": true,
"RegComingSoonInterest": true,
"RegActiveAdultInterest": true,
"WeeklyOptIn": true,
"WeeklyHomeOptIn": true,
"MarketOptIn": true,
"MailList": true,
"Bookmarks": [],
"SharedUserProfiles": [
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkOwnership": "sample string 34",
"LikedImagesCount": 1,
"BoardCount": 1,
"Boards": [],
"InvitationEmail": "sample string 35",
"LastLogon": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkData": []
},
{
"Id": 1,
"UserId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Initials": "sample string 5",
"ContentTypeId": 1,
"ContentTypeName": "sample string 6",
"ContentId": 1,
"Title": "sample string 7",
"Url": "sample string 8",
"Action": "Saved",
"Ownership": "sample string 9",
"DateChanged": "2025-04-19T09:31:13.3392139-05:00",
"Notes": [
"sample string 1",
"sample string 2"
],
"SharedUsers": [
{
"UserId": "sample string 1",
"LogonName": "sample string 2",
"PartnerId": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleName": "sample string 6",
"Initials": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"PostalCode": "sample string 10",
"Address1": "sample string 11",
"Address2": "sample string 12",
"Phone": "sample string 13",
"PhoneExt": "sample string 14",
"RegMetro": "sample string 15",
"SsoId": "sample string 16",
"ImageUrl": "sample string 17",
"MoveInDate": 18,
"FinancePreference": 19,
"Reason": 20,
"AgeRange": 21,
"HomePrefence": 22,
"Password": "sample string 23",
"DateRegistered": "2025-04-19T09:31:13.3392139-05:00",
"LeadOptIn": "sample string 26",
"RegBOYLInterest": true,
"RegComingSoonInterest": true,
"RegActiveAdultInterest": true,
"WeeklyOptIn": true,
"WeeklyHomeOptIn": true,
"MarketOptIn": true,
"MailList": true,
"Bookmarks": [],
"SharedUserProfiles": [
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkOwnership": "sample string 34",
"LikedImagesCount": 1,
"BoardCount": 1,
"Boards": [],
"InvitationEmail": "sample string 35",
"LastLogon": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserId": "sample string 1",
"LogonName": "sample string 2",
"PartnerId": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleName": "sample string 6",
"Initials": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"PostalCode": "sample string 10",
"Address1": "sample string 11",
"Address2": "sample string 12",
"Phone": "sample string 13",
"PhoneExt": "sample string 14",
"RegMetro": "sample string 15",
"SsoId": "sample string 16",
"ImageUrl": "sample string 17",
"MoveInDate": 18,
"FinancePreference": 19,
"Reason": 20,
"AgeRange": 21,
"HomePrefence": 22,
"Password": "sample string 23",
"DateRegistered": "2025-04-19T09:31:13.3392139-05:00",
"LeadOptIn": "sample string 26",
"RegBOYLInterest": true,
"RegComingSoonInterest": true,
"RegActiveAdultInterest": true,
"WeeklyOptIn": true,
"WeeklyHomeOptIn": true,
"MarketOptIn": true,
"MailList": true,
"Bookmarks": [],
"SharedUserProfiles": [
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkOwnership": "sample string 34",
"LikedImagesCount": 1,
"BoardCount": 1,
"Boards": [],
"InvitationEmail": "sample string 35",
"LastLogon": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkData": []
}
],
"ImageInfo": {
"Id": 1,
"Path": "sample string 2",
"ColorType": "sample string 3",
"Category": "sample string 4",
"Type": "sample string 5",
"Width": 1,
"Height": 1,
"Sequence": 6,
"ObjectLabels": "sample string 7"
},
"IntMedia": [
{
"Id": 1,
"Title": "sample string 2",
"Url": "sample string 3",
"Code": "sample string 4",
"UseFlash": true,
"Type": "sample string 6",
"Sequence": 7
},
{
"Id": 1,
"Title": "sample string 2",
"Url": "sample string 3",
"Code": "sample string 4",
"UseFlash": true,
"Type": "sample string 6",
"Sequence": 7
}
],
"Images": [
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
},
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
}
],
"Videos": [
{
"NhsVideoId": "sample string 1",
"BcRefId": "sample string 2",
"BuilderId": 3,
"CommunityId": 1,
"PlanId": 1,
"Sort": 1,
"Title": "sample string 4",
"Caption": "sample string 5",
"Url": "sample string 6",
"Type": "sample string 7",
"SubType": "sample string 8",
"ThumbnailUrl": "sample string 9"
},
{
"NhsVideoId": "sample string 1",
"BcRefId": "sample string 2",
"BuilderId": 3,
"CommunityId": 1,
"PlanId": 1,
"Sort": 1,
"Title": "sample string 4",
"Caption": "sample string 5",
"Url": "sample string 6",
"Type": "sample string 7",
"SubType": "sample string 8",
"ThumbnailUrl": "sample string 9"
}
],
"VideoTours": [
{
"Id": 1,
"Title": "sample string 1",
"Url": "sample string 2",
"ThumbnailUrl": "sample string 3"
},
{
"Id": 1,
"Title": "sample string 1",
"Url": "sample string 2",
"ThumbnailUrl": "sample string 3"
}
],
"IsLandExcluded": true,
"UrgencyData": [
{
"CommunityId": 1,
"UrgencyData": {
"sample string 1": {
"sample string 1": 2,
"sample string 3": 4
},
"sample string 2": {
"sample string 1": 2,
"sample string 3": 4
}
}
},
{
"CommunityId": 1,
"UrgencyData": {
"sample string 1": {
"sample string 1": 2,
"sample string 3": 4
},
"sample string 2": {
"sample string 1": 2,
"sample string 3": 4
}
}
}
],
"HasBuilderReviews": true,
"FeesAndRates": [
{
"Description": "sample string 1",
"TypeCode": "sample string 2",
"MonthlyFee": 3.0,
"YearlyFee": 4.0
},
{
"Description": "sample string 1",
"TypeCode": "sample string 2",
"MonthlyFee": 3.0,
"YearlyFee": 4.0
}
],
"Brochures": [
{
"Id": 1,
"Ftp": "sample string 2",
"Url": "sample string 3",
"Title": "sample string 4"
},
{
"Id": 1,
"Ftp": "sample string 2",
"Url": "sample string 3",
"Title": "sample string 4"
}
],
"Agents": [
{
"Email": "sample string 1",
"Img": "sample string 2",
"Name": "sample string 3",
"Title": "sample string 4",
"Phone": "sample string 5",
"BuilderId": 6,
"Broker": {
"Name": "sample string 1",
"Email": "sample string 2",
"WebSite": "sample string 3",
"Image": "sample string 4",
"Phone": "sample string 5"
}
},
{
"Email": "sample string 1",
"Img": "sample string 2",
"Name": "sample string 3",
"Title": "sample string 4",
"Phone": "sample string 5",
"BuilderId": 6,
"Broker": {
"Name": "sample string 1",
"Email": "sample string 2",
"WebSite": "sample string 3",
"Image": "sample string 4",
"Phone": "sample string 5"
}
}
],
"IsMasterPlanned": true,
"CommunityLotMap": "sample string 77",
"CommunityLotMaps": [
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
},
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
}
],
"Promos": [
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:31:13.3392139-05:00",
"End": "2025-04-19T09:31:13.3392139-05:00",
"Id": 8,
"TxtLng": "sample string 9",
"TxtShrt": "sample string 10"
},
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:31:13.3392139-05:00",
"End": "2025-04-19T09:31:13.3392139-05:00",
"Id": 8,
"TxtLng": "sample string 9",
"TxtShrt": "sample string 10"
}
],
"AgtPromos": [
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:31:13.3392139-05:00",
"End": "2025-04-19T09:31:13.3392139-05:00",
"Id": 8
},
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:31:13.3392139-05:00",
"End": "2025-04-19T09:31:13.3392139-05:00",
"Id": 8
}
],
"GreenPromos": [
{
"Name": "sample string 1",
"Url": "sample string 2",
"Flyer": "sample string 3"
},
{
"Name": "sample string 1",
"Url": "sample string 2",
"Flyer": "sample string 3"
}
],
"CommEvents": [
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Location": "sample string 4",
"EventFlyerUrl": "sample string 5",
"EventStartTime": "2025-04-19T09:31:13.3392139-05:00",
"EventEndTime": "2025-04-19T09:31:13.3392139-05:00",
"EventTypeCode": "sample string 8",
"FlyerId": 1
},
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Location": "sample string 4",
"EventFlyerUrl": "sample string 5",
"EventStartTime": "2025-04-19T09:31:13.3392139-05:00",
"EventEndTime": "2025-04-19T09:31:13.3392139-05:00",
"EventTypeCode": "sample string 8",
"FlyerId": 1
}
],
"Hours": "sample string 78",
"SalesOfficeAddress": "sample string 79",
"SalesOfficeCity": "sample string 80",
"SalesOfficeState": "sample string 81",
"SalesOfficeZip": "sample string 82",
"SalesOfficeEmail": "sample string 83",
"DrivingDirections": "sample string 84",
"ServiceRadius": 64,
"SchedulerUrl": "sample string 85"
},
"HasBuilderReviews": true
},
"Phone": "sample string 28"
},
"DateChanged": "2025-04-19T09:31:13.3392139-05:00"
},
{
"Id": 1,
"Action": 1,
"UserId": "sample string 2",
"BoardOwnerUserId": "sample string 3",
"UserContent": "sample string 4",
"ContentType": 1,
"ContentId": 1,
"ContentIds": [
1,
2
],
"TemplateId": 1,
"BookmarkId": 1,
"BookmarkIds": [
1,
2
],
"Likes": 1,
"Dislikes": 1,
"Comment": "sample string 5",
"Notes": [
"sample string 1",
"sample string 2"
],
"UserActions": [
{
"UserId": "sample string 1",
"Name": "sample string 2",
"Comment": "sample string 3",
"ByOwner": true,
"Like": true
},
{
"UserId": "sample string 1",
"Name": "sample string 2",
"Comment": "sample string 3",
"ByOwner": true,
"Like": true
}
],
"ImageInfo": {
"Id": 1,
"Path": "sample string 2",
"ColorType": "sample string 3",
"Category": "sample string 4",
"Type": "sample string 5",
"Width": 1,
"Height": 1,
"Sequence": 6,
"ObjectLabels": "sample string 7"
},
"HomeInfo": {
"HomeId": 1,
"CommId": 2,
"PlanId": 3,
"ListingId": 4,
"IsBasic": true,
"CommName": "sample string 6",
"PlanName": "sample string 7",
"IsSpec": true,
"MarketId": 9,
"BuilderId": 10,
"Br": 11,
"Ba": 12,
"HBa": 13,
"St": 14,
"Gr": 15,
"Sft": 16,
"Price": 17.0,
"Addr": "sample string 18",
"City": "sample string 19",
"County": "sample string 20",
"State": "sample string 21",
"Thumb1": "sample string 22",
"Thumb2": "sample string 23",
"IntImage": "sample string 24",
"Zip": "sample string 25",
"Status": "sample string 26",
"BrandLogo": "sample string 27",
"Brand": {
"Id": 1,
"Name": "sample string 2",
"BuilderId": 1,
"Logo": "sample string 3",
"LogoSmall": "sample string 4",
"MarketId": 1,
"City": "sample string 5",
"State": "sample string 6",
"SiteUrl": "sample string 7",
"ShowCaseStatusId": 1,
"IsBasic": 8,
"HasShowCase": 9,
"TotalHome": 1,
"CommunityCount": 1,
"BoylCount": 1,
"ModularCount": 1,
"CustomCount": 1,
"CustomBuilderCount": 1,
"PlanCount": 1,
"SpecCount": 1,
"UnderConstructionCount": 1,
"GalleryCount": 1,
"ShowMortgageLink": "sample string 10",
"CustomMortgageLink": "sample string 11",
"TestimonialCount": 1,
"IsBoyl": 12,
"IsModularBuilder": 13,
"IsCustomBuilder": 14,
"IsNewCustomBuilderLocation": 15,
"Overview": "sample string 16",
"Description": "sample string 17",
"RssFeed": "sample string 18",
"TwitterWidget": "sample string 19",
"FacebookWidget": "sample string 20",
"BrandUrl": "sample string 21",
"ContactEmail": "sample string 22",
"Location": {
"Id": 1,
"DudaUrl": "sample string 2",
"CommunityNumber": "sample string 3",
"Name": "sample string 4",
"Desc": "sample string 5",
"Lat": "sample string 6",
"Lng": "sample string 7",
"SalesOfficeLat": "sample string 8",
"SalesOfficeLng": "sample string 9",
"BuilderId": 10,
"MarketId": 11,
"MarketName": "sample string 12",
"ParentId": 13,
"BrLo": 14,
"BrHi": 15,
"BaLo": 16,
"BaHi": 17,
"HBaLo": 18,
"HBaHi": 19,
"SftLo": 1,
"SftHi": 1,
"PrLo": 1,
"PrHi": 1,
"GrLow": 1.0,
"GrHi": 1.0,
"Addr": "sample string 20",
"City": "sample string 21",
"County": "sample string 22",
"State": "sample string 23",
"StateName": "sample string 24",
"Zip": "sample string 25",
"Thumb1": "sample string 26",
"Thumb2": "sample string 27",
"Thumb3": "sample string 28",
"Status": "sample string 29",
"NumHomes": 30,
"NumQmi": 31,
"NumQmiDone": 32,
"Phone": "sample string 33",
"IsTrackingNumber": true,
"SalesOfficePhone": "sample string 35",
"Amenities": [
{
"Type": "sample string 1",
"TypeCode": "sample string 2",
"Name": "sample string 3",
"Url": "sample string 4",
"Open": 5,
"Sequence": 7
},
{
"Type": "sample string 1",
"TypeCode": "sample string 2",
"Name": "sample string 3",
"Url": "sample string 4",
"Open": 5,
"Sequence": 7
}
],
"CustomAmenities": [
{
"Id": 1,
"GrpName": "sample string 2",
"Desc": "sample string 3",
"Url": "sample string 4",
"Pos": 5
},
{
"Id": 1,
"GrpName": "sample string 2",
"Desc": "sample string 3",
"Url": "sample string 4",
"Pos": 5
}
],
"SchoolDistricts": [
{
"Id": 1,
"Name": "sample string 2",
"DistrictName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"DistrictName": "sample string 3"
}
],
"Schools": [
{
"Id": 1,
"Name": "sample string 2",
"DistrictName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"DistrictName": "sample string 3"
}
],
"HasHotHomes": 36,
"HasModelHome": 37,
"IsGreen": 38,
"IsUrban": 39,
"IsGated": 40,
"IsAdult": 41,
"Nature": 42,
"Pool": 43,
"Views": 44,
"Golf": 45,
"WaterFront": 46,
"Sports": 47,
"Parks": 48,
"IsCondo": 49,
"IsTownHome": 50,
"IsAgeRest": 51,
"IsLuxury": true,
"Promo": 53,
"AgtPromo": 54,
"HasEvent": 55,
"HasVideo": 56,
"Dist": 57.1,
"IsBasic": 58,
"BuilderCount": 59,
"CommunityType": "sample string 60",
"ProjectType": "sample string 61",
"MarketingHeadline": "sample string 62",
"CommunityUrl": "sample string 63",
"ShowDevNm": true,
"IsBoyl": true,
"IsCustom": true,
"IsManufactured": true,
"NumModelsHomes": 68,
"ModelHomes": 69,
"PlansCount": 70,
"CompleteCount": 71,
"UnderConstruction": 72,
"FulfillmentCode": "sample string 73",
"PreferredScore": 1,
"Bookmarks": [
{
"Id": 1,
"UserId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Initials": "sample string 5",
"ContentTypeId": 1,
"ContentTypeName": "sample string 6",
"ContentId": 1,
"Title": "sample string 7",
"Url": "sample string 8",
"Action": "Saved",
"Ownership": "sample string 9",
"DateChanged": "2025-04-19T09:31:13.3392139-05:00",
"Notes": [
"sample string 1",
"sample string 2"
],
"SharedUsers": [
{
"UserId": "sample string 1",
"LogonName": "sample string 2",
"PartnerId": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleName": "sample string 6",
"Initials": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"PostalCode": "sample string 10",
"Address1": "sample string 11",
"Address2": "sample string 12",
"Phone": "sample string 13",
"PhoneExt": "sample string 14",
"RegMetro": "sample string 15",
"SsoId": "sample string 16",
"ImageUrl": "sample string 17",
"MoveInDate": 18,
"FinancePreference": 19,
"Reason": 20,
"AgeRange": 21,
"HomePrefence": 22,
"Password": "sample string 23",
"DateRegistered": "2025-04-19T09:31:13.3392139-05:00",
"LeadOptIn": "sample string 26",
"RegBOYLInterest": true,
"RegComingSoonInterest": true,
"RegActiveAdultInterest": true,
"WeeklyOptIn": true,
"WeeklyHomeOptIn": true,
"MarketOptIn": true,
"MailList": true,
"Bookmarks": [],
"SharedUserProfiles": [
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkOwnership": "sample string 34",
"LikedImagesCount": 1,
"BoardCount": 1,
"Boards": [],
"InvitationEmail": "sample string 35",
"LastLogon": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserId": "sample string 1",
"LogonName": "sample string 2",
"PartnerId": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleName": "sample string 6",
"Initials": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"PostalCode": "sample string 10",
"Address1": "sample string 11",
"Address2": "sample string 12",
"Phone": "sample string 13",
"PhoneExt": "sample string 14",
"RegMetro": "sample string 15",
"SsoId": "sample string 16",
"ImageUrl": "sample string 17",
"MoveInDate": 18,
"FinancePreference": 19,
"Reason": 20,
"AgeRange": 21,
"HomePrefence": 22,
"Password": "sample string 23",
"DateRegistered": "2025-04-19T09:31:13.3392139-05:00",
"LeadOptIn": "sample string 26",
"RegBOYLInterest": true,
"RegComingSoonInterest": true,
"RegActiveAdultInterest": true,
"WeeklyOptIn": true,
"WeeklyHomeOptIn": true,
"MarketOptIn": true,
"MailList": true,
"Bookmarks": [],
"SharedUserProfiles": [
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkOwnership": "sample string 34",
"LikedImagesCount": 1,
"BoardCount": 1,
"Boards": [],
"InvitationEmail": "sample string 35",
"LastLogon": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkData": []
},
{
"Id": 1,
"UserId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Initials": "sample string 5",
"ContentTypeId": 1,
"ContentTypeName": "sample string 6",
"ContentId": 1,
"Title": "sample string 7",
"Url": "sample string 8",
"Action": "Saved",
"Ownership": "sample string 9",
"DateChanged": "2025-04-19T09:31:13.3392139-05:00",
"Notes": [
"sample string 1",
"sample string 2"
],
"SharedUsers": [
{
"UserId": "sample string 1",
"LogonName": "sample string 2",
"PartnerId": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleName": "sample string 6",
"Initials": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"PostalCode": "sample string 10",
"Address1": "sample string 11",
"Address2": "sample string 12",
"Phone": "sample string 13",
"PhoneExt": "sample string 14",
"RegMetro": "sample string 15",
"SsoId": "sample string 16",
"ImageUrl": "sample string 17",
"MoveInDate": 18,
"FinancePreference": 19,
"Reason": 20,
"AgeRange": 21,
"HomePrefence": 22,
"Password": "sample string 23",
"DateRegistered": "2025-04-19T09:31:13.3392139-05:00",
"LeadOptIn": "sample string 26",
"RegBOYLInterest": true,
"RegComingSoonInterest": true,
"RegActiveAdultInterest": true,
"WeeklyOptIn": true,
"WeeklyHomeOptIn": true,
"MarketOptIn": true,
"MailList": true,
"Bookmarks": [],
"SharedUserProfiles": [
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkOwnership": "sample string 34",
"LikedImagesCount": 1,
"BoardCount": 1,
"Boards": [],
"InvitationEmail": "sample string 35",
"LastLogon": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserId": "sample string 1",
"LogonName": "sample string 2",
"PartnerId": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleName": "sample string 6",
"Initials": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"PostalCode": "sample string 10",
"Address1": "sample string 11",
"Address2": "sample string 12",
"Phone": "sample string 13",
"PhoneExt": "sample string 14",
"RegMetro": "sample string 15",
"SsoId": "sample string 16",
"ImageUrl": "sample string 17",
"MoveInDate": 18,
"FinancePreference": 19,
"Reason": 20,
"AgeRange": 21,
"HomePrefence": 22,
"Password": "sample string 23",
"DateRegistered": "2025-04-19T09:31:13.3392139-05:00",
"LeadOptIn": "sample string 26",
"RegBOYLInterest": true,
"RegComingSoonInterest": true,
"RegActiveAdultInterest": true,
"WeeklyOptIn": true,
"WeeklyHomeOptIn": true,
"MarketOptIn": true,
"MailList": true,
"Bookmarks": [],
"SharedUserProfiles": [
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
},
{
"UserSharedEmail": "sample string 1",
"Status": "sample string 2",
"Date": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkOwnership": "sample string 34",
"LikedImagesCount": 1,
"BoardCount": 1,
"Boards": [],
"InvitationEmail": "sample string 35",
"LastLogon": "2025-04-19T09:31:13.3392139-05:00"
}
],
"BookmarkData": []
}
],
"ImageInfo": {
"Id": 1,
"Path": "sample string 2",
"ColorType": "sample string 3",
"Category": "sample string 4",
"Type": "sample string 5",
"Width": 1,
"Height": 1,
"Sequence": 6,
"ObjectLabels": "sample string 7"
},
"IntMedia": [
{
"Id": 1,
"Title": "sample string 2",
"Url": "sample string 3",
"Code": "sample string 4",
"UseFlash": true,
"Type": "sample string 6",
"Sequence": 7
},
{
"Id": 1,
"Title": "sample string 2",
"Url": "sample string 3",
"Code": "sample string 4",
"UseFlash": true,
"Type": "sample string 6",
"Sequence": 7
}
],
"Images": [
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
},
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
}
],
"Videos": [
{
"NhsVideoId": "sample string 1",
"BcRefId": "sample string 2",
"BuilderId": 3,
"CommunityId": 1,
"PlanId": 1,
"Sort": 1,
"Title": "sample string 4",
"Caption": "sample string 5",
"Url": "sample string 6",
"Type": "sample string 7",
"SubType": "sample string 8",
"ThumbnailUrl": "sample string 9"
},
{
"NhsVideoId": "sample string 1",
"BcRefId": "sample string 2",
"BuilderId": 3,
"CommunityId": 1,
"PlanId": 1,
"Sort": 1,
"Title": "sample string 4",
"Caption": "sample string 5",
"Url": "sample string 6",
"Type": "sample string 7",
"SubType": "sample string 8",
"ThumbnailUrl": "sample string 9"
}
],
"VideoTours": [
{
"Id": 1,
"Title": "sample string 1",
"Url": "sample string 2",
"ThumbnailUrl": "sample string 3"
},
{
"Id": 1,
"Title": "sample string 1",
"Url": "sample string 2",
"ThumbnailUrl": "sample string 3"
}
],
"IsLandExcluded": true,
"UrgencyData": [
{
"CommunityId": 1,
"UrgencyData": {
"sample string 1": {
"sample string 1": 2,
"sample string 3": 4
},
"sample string 2": {
"sample string 1": 2,
"sample string 3": 4
}
}
},
{
"CommunityId": 1,
"UrgencyData": {
"sample string 1": {
"sample string 1": 2,
"sample string 3": 4
},
"sample string 2": {
"sample string 1": 2,
"sample string 3": 4
}
}
}
],
"HasBuilderReviews": true,
"FeesAndRates": [
{
"Description": "sample string 1",
"TypeCode": "sample string 2",
"MonthlyFee": 3.0,
"YearlyFee": 4.0
},
{
"Description": "sample string 1",
"TypeCode": "sample string 2",
"MonthlyFee": 3.0,
"YearlyFee": 4.0
}
],
"Brochures": [
{
"Id": 1,
"Ftp": "sample string 2",
"Url": "sample string 3",
"Title": "sample string 4"
},
{
"Id": 1,
"Ftp": "sample string 2",
"Url": "sample string 3",
"Title": "sample string 4"
}
],
"Agents": [
{
"Email": "sample string 1",
"Img": "sample string 2",
"Name": "sample string 3",
"Title": "sample string 4",
"Phone": "sample string 5",
"BuilderId": 6,
"Broker": {
"Name": "sample string 1",
"Email": "sample string 2",
"WebSite": "sample string 3",
"Image": "sample string 4",
"Phone": "sample string 5"
}
},
{
"Email": "sample string 1",
"Img": "sample string 2",
"Name": "sample string 3",
"Title": "sample string 4",
"Phone": "sample string 5",
"BuilderId": 6,
"Broker": {
"Name": "sample string 1",
"Email": "sample string 2",
"WebSite": "sample string 3",
"Image": "sample string 4",
"Phone": "sample string 5"
}
}
],
"IsMasterPlanned": true,
"CommunityLotMap": "sample string 77",
"CommunityLotMaps": [
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
},
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
}
],
"Promos": [
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:31:13.3392139-05:00",
"End": "2025-04-19T09:31:13.3392139-05:00",
"Id": 8,
"TxtLng": "sample string 9",
"TxtShrt": "sample string 10"
},
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:31:13.3392139-05:00",
"End": "2025-04-19T09:31:13.3392139-05:00",
"Id": 8,
"TxtLng": "sample string 9",
"TxtShrt": "sample string 10"
}
],
"AgtPromos": [
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:31:13.3392139-05:00",
"End": "2025-04-19T09:31:13.3392139-05:00",
"Id": 8
},
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:31:13.3392139-05:00",
"End": "2025-04-19T09:31:13.3392139-05:00",
"Id": 8
}
],
"GreenPromos": [
{
"Name": "sample string 1",
"Url": "sample string 2",
"Flyer": "sample string 3"
},
{
"Name": "sample string 1",
"Url": "sample string 2",
"Flyer": "sample string 3"
}
],
"CommEvents": [
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Location": "sample string 4",
"EventFlyerUrl": "sample string 5",
"EventStartTime": "2025-04-19T09:31:13.3392139-05:00",
"EventEndTime": "2025-04-19T09:31:13.3392139-05:00",
"EventTypeCode": "sample string 8",
"FlyerId": 1
},
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Location": "sample string 4",
"EventFlyerUrl": "sample string 5",
"EventStartTime": "2025-04-19T09:31:13.3392139-05:00",
"EventEndTime": "2025-04-19T09:31:13.3392139-05:00",
"EventTypeCode": "sample string 8",
"FlyerId": 1
}
],
"Hours": "sample string 78",
"SalesOfficeAddress": "sample string 79",
"SalesOfficeCity": "sample string 80",
"SalesOfficeState": "sample string 81",
"SalesOfficeZip": "sample string 82",
"SalesOfficeEmail": "sample string 83",
"DrivingDirections": "sample string 84",
"ServiceRadius": 64,
"SchedulerUrl": "sample string 85"
},
"HasBuilderReviews": true
},
"Phone": "sample string 28"
},
"DateChanged": "2025-04-19T09:31:13.3392139-05:00"
}
]
}
}
Sample not available.
Sample not available.
Code Generator
Response Information
List of Bookmark Data
ApiResultModelOfApiBoardData| Name | Description | Type | Additional information |
|---|---|---|---|
| Time | string |
None. |
|
| Error | Exception |
None. |
|
| ErrorMessage | string |
None. |
|
| Status | string |
None. |
|
| Server | string |
None. |
|
| Count | integer |
None. |
|
| FavoriteCounts | ApiFavoriteCounts |
None. |
|
| FavoriteFacets | ApiFavoriteFacets |
None. |
|
| Result | ApiBoardData |
None. |
|
| VerboseLogger | List of IVerboseLogger |
None. |
GET
api/v2/User/BookmarkData?partnerId={partnerId}&userId={userId}&bookmarkId={bookmarkId}&templateId={templateId}&showNotes={showNotes}&showLikes={showLikes}&bookmarkIds={bookmarkIds}&showUserActions={showUserActions}&showImageInfo={showImageInfo}&showHomeInfo={showHomeInfo}