YM REST Services

<back to all web services

WebScraper

Requires Authentication
The following routes are available for this service:
POST/Ams/{ClientID}/Member/{MemberID}/WebScraperWeb Scraper for parsing Urls in Wall Posts.
WebScraper Parameters:
NameParameterData TypeRequiredDescription
ResourceUrlbodystringNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
WebScraperResponse Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
DescriptionformstringNo
WebsiteformstringNo
PostHtmlformstringNo
ImagesformList<Image>No
ImagesScannedformintNo
Image Parameters:
NameParameterData TypeRequiredDescription
SrcformstringNo
WidthformintNo
HeightformintNo
AutoFitformboolNo
IndexformintNo
TokenformstringNo
OriginalSrcformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/Member/{MemberID}/WebScraper HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ResourceUrl":"String","MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T08:40:31.7016744-04:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Title":"String","Description":"String","Website":"String","PostHtml":"String","Images":[{"Src":"String","Width":0,"Height":0,"AutoFit":false,"Index":0,"Token":"String","OriginalSrc":"String"}],"ImagesScanned":0,"ResourceUrl":"String","MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T08:40:31.7076723-04:00","Device":"Desktop"}