YM REST Services

<back to all web services

ContentAreas

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/ContentAreasReturn a content area.
PUT/Ams/{ClientID}/ContentAreasUpdate a content area.
ContentAreas Parameters:
NameParameterData TypeRequiredDescription
AreaTypebodystringNo
VersionIDbodyint?No
RevertbodyboolNo
VersionLabelbodystringNo
VersionNotesbodystringNo
PublishbodyboolNo
ContentAreabodyContentAreaNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ContentArea Parameters:
NameParameterData TypeRequiredDescription
TitleDefaultformstringNo
TitleformstringNo
BodyformstringNo
AutoFormattedformintNo
AllowSponsorRotatorWidgetformboolNo
ContentTypeformintNo
RotatorIdformint?No
AreaStatusformintNo
VersionIDformint?No
ModifiedAtformDateTime?No
ModifiedByLastNameformstringNo
ModifiedByFirstNameformstringNo
MessageTypeformstringNo
MessageLocationformstringNo
MessageTypeIDformstringNo

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.

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

{"AreaType":"String","VersionID":0,"Revert":false,"VersionLabel":"String","VersionNotes":"String","Publish":false,"ContentArea":{"TitleDefault":"String","Title":"String","Body":"String","AutoFormatted":0,"AllowSponsorRotatorWidget":false,"ContentType":0,"RotatorId":0,"AreaStatus":0,"VersionID":0,"ModifiedAt":"0001-01-01T00:00:00.0000000","ModifiedByLastName":"String","ModifiedByFirstName":"String","MessageType":"String","MessageLocation":"String","MessageTypeID":"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":"2025-01-15T08:50:36.1742143-05:00","Device":"Desktop"}

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

{"AreaType":"String","VersionID":0,"Revert":false,"VersionLabel":"String","VersionNotes":"String","Publish":false,"ContentArea":{"TitleDefault":"String","Title":"String","Body":"String","AutoFormatted":0,"AllowSponsorRotatorWidget":false,"ContentType":0,"RotatorId":0,"AreaStatus":0,"VersionID":0,"ModifiedAt":"0001-01-01T00:00:00.0000000","ModifiedByLastName":"String","ModifiedByFirstName":"String","MessageType":"String","MessageLocation":"String","MessageTypeID":"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":"2025-01-15T08:50:36.1742143-05:00","Device":"Desktop"}