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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomPageFileCollectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <FileCollectionID>0</FileCollectionID>
  <FileCollectionName>String</FileCollectionName>
  <CustomPageFileCollections>
    <CustomPageFileCollection>
      <FileCollectionID>0</FileCollectionID>
      <FileCollectionName>String</FileCollectionName>
    </CustomPageFileCollection>
  </CustomPageFileCollections>
</CustomPageFileCollectionsResponse>