YM REST Services

<back to all web services

FilesUpload

Requires Authentication
Requires any of the roles:member, oauthmember, admin, oauthadmin
The following routes are available for this service:
POST/Ams/{ClientID}/FilesUploadUpload community files.
POST/Ams/{ClientID}/Member/{MemberID}/FilesUploadUpload files to the Member's account.
FilesUpload Parameters:
NameParameterData TypeRequiredDescription
GroupIdbodyintNo
AlbumIdbodyintNo
CaptionbodystringNo
FileTypebodyFileTypeNo

Allowable Values

  • Profile
  • Gallery
  • Logo
  • Feed
  • Document
  • OrgPostPhoto
  • OrgImageAsset
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
FilesUploadResponse Parameters:
NameParameterData TypeRequiredDescription
UrlformList<string>No
OrientationformOrientationNo

Allowable Values

  • None
  • Portrait
  • Landscape

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

HTTP + JSV

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

POST /Ams/{ClientID}/FilesUpload HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GroupId: 0,
	AlbumId: 0,
	Caption: String,
	FileType: Profile,
	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-02T23:56:01.9220223-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Url: 
	[
		String
	],
	Orientation: None,
	GroupId: 0,
	AlbumId: 0,
	Caption: String,
	FileType: Profile,
	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-02T23:56:01.9220223-04:00,
	Device: Desktop
}