YM REST Services

<back to all web services

CustomPageVersions

Requires Authentication
Requires any of the roles:admin, oauthadmin, admin, oauthadmin, admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/CustomPageVersionsReturn custom page versions.
POST/Ams/{ClientID}/CustomPageVersionsPublish or Unpublish a custom page versions.
DELETE/Ams/{ClientID}/CustomPageVersionsDelete a custom page versions.
CustomPageVersions Parameters:
NameParameterData TypeRequiredDescription
PageIDbodyintNo
VersionIDbodyintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CustomPageVersionsResponse Parameters:
NameParameterData TypeRequiredDescription
CustomPageVersionsformList<CustomPageVersion>No
CustomPageVersion Parameters:
NameParameterData TypeRequiredDescription
VersionIDformintNo
PageIDformintNo
StatusformintNo
TitleformstringNo
BodyformstringNo
LabelformstringNo
NotesformstringNo
DateModifiedformDateTimeNo
EditorNameformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/CustomPageVersions HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PageID":0,"VersionID":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-03T05:17:48.0986518-04:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CustomPageVersions":[{"VersionID":0,"PageID":0,"Status":0,"Title":"String","Body":"String","Label":"String","Notes":"String","DateModified":"0001-01-01T00:00:00.0000000","EditorName":"String"}],"PageID":0,"VersionID":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-03T05:17:48.0986518-04:00","Device":"Desktop"}