sfgboxapi

<back to all web services

MediaAdd

The following routes are available for this service:
POST/media
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class MediaAdd
    {
        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Long tenantsId = null;

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public String entity = null;

        @DataMember(Order=5)
        @Validate(Validator="NotNull")
        public Long entityId = null;

        @DataMember(Order=6)
        @Validate(Validator="NotNull")
        public String mediaType = null;

        @DataMember(Order=7)
        public String mediaPath = null;

        @DataMember(Order=8)
        public Long questionnairsId = null;

        @DataMember(Order=9)
        public String name = null;

        @DataMember(Order=10)
        public Boolean free = null;

        @DataMember(Order=11)
        public UUID publicAccessGuid = null;
        
        public Long getTenantsId() { return tenantsId; }
        public MediaAdd setTenantsId(Long value) { this.tenantsId = value; return this; }
        public String getEntity() { return entity; }
        public MediaAdd setEntity(String value) { this.entity = value; return this; }
        public Long getEntityId() { return entityId; }
        public MediaAdd setEntityId(Long value) { this.entityId = value; return this; }
        public String getMediaType() { return mediaType; }
        public MediaAdd setMediaType(String value) { this.mediaType = value; return this; }
        public String getMediaPath() { return mediaPath; }
        public MediaAdd setMediaPath(String value) { this.mediaPath = value; return this; }
        public Long getQuestionnairsId() { return questionnairsId; }
        public MediaAdd setQuestionnairsId(Long value) { this.questionnairsId = value; return this; }
        public String getName() { return name; }
        public MediaAdd setName(String value) { this.name = value; return this; }
        public Boolean isFree() { return free; }
        public MediaAdd setFree(Boolean value) { this.free = value; return this; }
        public UUID getPublicAccessGuid() { return publicAccessGuid; }
        public MediaAdd setPublicAccessGuid(UUID value) { this.publicAccessGuid = value; return this; }
    }

    public static class MediaAddResponse
    {
        @DataMember(Order=2)
        public Long tenantsId = null;

        @DataMember(Order=3)
        public String entity = null;

        @DataMember(Order=5)
        public Long entityId = null;

        @DataMember(Order=6)
        public String mediaType = null;

        @DataMember(Order=7)
        public String mediaPath = null;

        @DataMember(Order=8)
        public Long questionnairsId = null;

        @DataMember(Order=9)
        public String name = null;

        @DataMember(Order=10)
        public Boolean free = null;

        @DataMember(Order=11)
        public UUID publicAccessGuid = null;

        @DataMember(Order=12)
        public ResponseStatus responseStatus = null;
        
        public Long getTenantsId() { return tenantsId; }
        public MediaAddResponse setTenantsId(Long value) { this.tenantsId = value; return this; }
        public String getEntity() { return entity; }
        public MediaAddResponse setEntity(String value) { this.entity = value; return this; }
        public Long getEntityId() { return entityId; }
        public MediaAddResponse setEntityId(Long value) { this.entityId = value; return this; }
        public String getMediaType() { return mediaType; }
        public MediaAddResponse setMediaType(String value) { this.mediaType = value; return this; }
        public String getMediaPath() { return mediaPath; }
        public MediaAddResponse setMediaPath(String value) { this.mediaPath = value; return this; }
        public Long getQuestionnairsId() { return questionnairsId; }
        public MediaAddResponse setQuestionnairsId(Long value) { this.questionnairsId = value; return this; }
        public String getName() { return name; }
        public MediaAddResponse setName(String value) { this.name = value; return this; }
        public Boolean isFree() { return free; }
        public MediaAddResponse setFree(Boolean value) { this.free = value; return this; }
        public UUID getPublicAccessGuid() { return publicAccessGuid; }
        public MediaAddResponse setPublicAccessGuid(UUID value) { this.publicAccessGuid = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public MediaAddResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java MediaAdd DTOs

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: sfgboxapi.dev.scadsoftware.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
		}
	}
}