sfgboxapi

MediaEdit

The following routes are available for this service:
PUT	/media/{Id}


export class MediaEditResponse
{
    // @DataMember(Order=1)
    public id: number;

    // @DataMember(Order=2)
    public tenantsId: number;

    // @DataMember(Order=4)
    public entity: string;

    // @DataMember(Order=5)
    public entityId: number;

    // @DataMember(Order=6)
    public mediaType: string;

    // @DataMember(Order=7)
    public mediaPath?: string;

    // @DataMember(Order=8)
    public questionnairsId?: number;

    // @DataMember(Order=9)
    public name: string;

    // @DataMember(Order=10)
    public free: boolean;

    // @DataMember(Order=11)
    public publicAccessGuid: string;

    // @DataMember(Order=12)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<MediaEditResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class MediaEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public id: number;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public tenantsId: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public entity: string;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public entityId: number;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public mediaType: string;

    // @DataMember(Order=7)
    public mediaPath?: string;

    // @DataMember(Order=8)
    public questionnairsId?: number;

    // @DataMember(Order=9)
    public name: string;

    // @DataMember(Order=10)
    public free: boolean;

    // @DataMember(Order=11)
    public publicAccessGuid: string;

    public constructor(init?: Partial<MediaEdit>) { (Object as any).assign(this, init); }
}

TypeScript MediaEdit 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.

PUT /media/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	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

{
	id: 0,
	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
		}
	}
}