YM REST Services

<back to all web services

CustomPageDocTypes

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/CustomPageDocTypesReturn a list of Document Types for Microsite page.
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CustomPageDocTypesResponse Parameters:
NameParameterData TypeRequiredDescription
DocTypesformList<CustomPageDocType>No
CustomPageDocType Parameters:
NameParameterData TypeRequiredDescription
DocTypeIDformstringNo
DocTypeNameformstringNo

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.

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

{"DocTypes":[{"DocTypeID":"String","DocTypeName":"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-03T04:20:50.9991173-04:00","Device":"Desktop"}