sfgboxapi

<back to all web services

MediaAdd

The following routes are available for this service:
POST/media
MediaAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodylongYes
EntitybodystringYes
EntityIdbodylongYes
MediaTypebodystringYes
MediaPathbodystringNo
QuestionnairsIdbodylong?No
NamebodystringNo
FreebodyboolNo
PublicAccessGuidbodyGuidNo
MediaAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformlongNo
EntityformstringNo
EntityIdformlongNo
MediaTypeformstringNo
MediaPathformstringNo
QuestionnairsIdformlong?No
NameformstringNo
FreeformboolNo
PublicAccessGuidformGuidNo
ResponseStatusformResponseStatusNo

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 /media HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	entity: String,
	entityId: 0,
	mediaType: String,
	mediaPath: String,
	questionnairsId: 0,
	name: String,
	free: False,
	publicAccessGuid: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	entity: String,
	entityId: 0,
	mediaType: String,
	mediaPath: String,
	questionnairsId: 0,
	name: String,
	free: False,
	publicAccessGuid: 00000000000000000000000000000000,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}