YM REST Services

<back to all web services

CustomPageFileCollections

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/CustomPageFileCollectionsReturn a Custom Page's File Collections.
CustomPageFileCollections Parameters:
NameParameterData TypeRequiredDescription
GroupIDqueryintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CustomPageFileCollectionsResponse Parameters:
NameParameterData TypeRequiredDescription
CustomPageFileCollectionsformList<CustomPageFileCollection>No
CustomPageFileCollection Parameters:
NameParameterData TypeRequiredDescription
FileCollectionIDformintNo
FileCollectionNameformstringNo

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.

GET /Ams/{ClientID}/CustomPageFileCollections HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CustomPageFileCollections: 
	[
		{
			FileCollectionID: 0,
			FileCollectionName: String
		}
	],
	FileCollectionID: 0,
	FileCollectionName: String
}