sfgboxapi

<back to all web services

MediaAdd

The following routes are available for this service:
POST/media

export class MediaAddResponse
{
    // @DataMember(Order=2)
    public tenantsId: number;

    // @DataMember(Order=3)
    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<MediaAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class MediaAdd
{
    // @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<MediaAdd>) { (Object as any).assign(this, init); }
}

TypeScript MediaAdd DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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"}}}