YM REST Services

<back to all web services

ContentAreaVersions

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/ContentAreaVersionsReturn a content area versions.
DELETE/Ams/{ClientID}/ContentAreaVersionsDelete a content area version.
ContentAreaVersions Parameters:
NameParameterData TypeRequiredDescription
AreaTypequerystringNo
VersionIDqueryintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ContentAreaVersionsResponse Parameters:
NameParameterData TypeRequiredDescription
ContentAreaVersionsformList<ContentAreaVersion>No
ContentAreaVersion Parameters:
NameParameterData TypeRequiredDescription
VersionIDformintNo
EditorNameformstringNo
TitleformstringNo
BodyformstringNo
LabelformstringNo
NotesformstringNo
LastModifiedDateformDateTimeNo
StatusformintNo

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.

GET /Ams/{ClientID}/ContentAreaVersions HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ContentAreaVersions":[{"VersionID":0,"EditorName":"String","Title":"String","Body":"String","Label":"String","Notes":"String","LastModifiedDate":"0001-01-01T00:00:00.0000000","Status":0}],"AreaType":"String","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-03T09:10:18.3667362-04:00","Device":"Desktop"}