YM REST Services

WebScraper

The following routes are available for this service:
POST	/Ams/{ClientID}/Member/{MemberID}/WebScraper	Web Scraper for parsing Urls in Wall Posts.

**WebScraper** Parameters:
Name	Parameter	Data Type	Required	Description
ResourceUrl	body	string	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**WebScraperResponse** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
Description	form	string	No
Website	form	string	No
PostHtml	form	string	No
Images	form	List<Image>	No
ImagesScanned	form	int	No

**Image** Parameters:
Name	Parameter	Data Type	Required
Src	form	string	No
Width	form	int	No
Height	form	int	No
AutoFit	form	bool	No
Index	form	int	No
Token	form	string	No
OriginalSrc	form	string	No

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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-03T02:39:19.3287717-04:00,
	Device: Desktop
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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-03T02:39:19.3357731-04:00,
	Device: Desktop
}