YM REST Services

<back to all web services

Networks

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/NetworksReturn a list of network URLs for a member.
POST/Ams/{ClientID}/Member/{MemberID}/NetworksAdd a network URL to member profile.
DELETE/Ams/{ClientID}/Member/{MemberID}/NetworksRemove a network URL from member profile.
Networks Parameters:
NameParameterData TypeRequiredDescription
NetworkIdbodyintNo
NetworkNamebodystringNo
LinkIdbodyintNo
UrlbodystringNo
PageNumberbodyintNo
PageSizebodyintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
NetworksResponse Parameters:
NameParameterData TypeRequiredDescription
NetworkListformList<Network>No
Network Parameters:
NameParameterData TypeRequiredDescription
LinkIdformintNo
UrlformstringNo
NetworkNameformstringNo
NetworkIdformintNo

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}/Networks HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NetworkId: 0,
	NetworkName: String,
	LinkId: 0,
	Url: String,
	PageNumber: 0,
	PageSize: 0,
	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-03T03:31:29.2872957-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	NetworkList: 
	[
		{
			LinkId: 0,
			Url: String,
			NetworkName: String,
			NetworkId: 0
		}
	],
	NetworkId: 0,
	NetworkName: String,
	LinkId: 0,
	Url: String,
	PageNumber: 0,
	PageSize: 0,
	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-03T03:31:29.3029128-04:00,
	Device: Desktop
}