Blazor Diffusion

<back to all web services

QueryAlbums

Albums

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public skip?: number;

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

    // @DataMember(Order=3)
    public orderBy: string;

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

    // @DataMember(Order=5)
    public include: string;

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

    // @DataMember(Order=7)
    public meta: { [index:string]: string; };

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

export class QueryDb<T> extends QueryBase
{

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

// @DataContract
export class AuditBase
{
    // @DataMember(Order=1)
    public createdDate: string;

    // @DataMember(Order=2)
    // @Required()
    public createdBy: string;

    // @DataMember(Order=3)
    public modifiedDate: string;

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

    // @DataMember(Order=5)
    public deletedDate?: string;

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

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

export class Artifact extends AuditBase
{
    public id: number;
    // @References("typeof(BlazorDiffusion.ServiceModel.Creative)")
    public creativeId: number;

    public fileName: string;
    public filePath: string;
    public contentType: string;
    public contentLength: number;
    public width: number;
    public height: number;
    public seed: number;
    public prompt: string;
    public nsfw?: boolean;
    public averageHash?: number;
    public perceptualHash?: number;
    public differenceHash?: number;
    public background?: string;
    public lqip?: string;
    public quality: number;
    public likesCount: number;
    public albumsCount: number;
    public downloadsCount: number;
    public searchCount: number;
    public temporalScore: number;
    public score: number;
    public rank: number;
    public refId: string;
    public versions: { [index:string]: string; } = {};

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

export class AlbumArtifact
{
    public id: number;
    // @References("typeof(BlazorDiffusion.ServiceModel.Album)")
    public albumId: number;

    // @References("typeof(BlazorDiffusion.ServiceModel.Artifact)")
    public artifactId: number;

    public description?: string;
    public createdDate: string;
    public modifiedDate: string;
    public artifact?: Artifact;

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

export class Album extends AuditBase
{
    public id: number;
    public name?: string;
    public description: string;
    public slug: string;
    public tags: string[] = [];
    public refId: string;
    public ownerId: number;
    public ownerRef: string;
    public primaryArtifactId?: number;
    public private: boolean;
    public rating?: number;
    public likesCount: number;
    public downloadsCount: number;
    public searchCount: number;
    public score: number;
    public rank: number;
    public prefColumns?: number;
    public artifacts: AlbumArtifact[] = [];

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

export class QueryAlbums extends QueryDb<Album>
{
    public id?: number;
    public ids?: number[];

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

export class ArtifactResult extends Artifact
{
    public userPrompt: string;
    public artistNames: string[] = [];
    public modifierNames: string[] = [];
    public primaryArtifactId?: number;
    public ownerRef: string;
    public similarity?: number;

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

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public offset: number;

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

    // @DataMember(Order=3)
    public results: ArtifactResult[];

    // @DataMember(Order=4)
    public meta: { [index:string]: string; };

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

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

TypeScript QueryAlbums DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/QueryAlbums HTTP/1.1 
Host: blazordiffusion.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":0,"ids":[0],"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"name":"String","description":"String","slug":"String","tags":["String"],"refId":"String","ownerId":0,"ownerRef":"String","primaryArtifactId":0,"private":false,"rating":0,"likesCount":0,"downloadsCount":0,"searchCount":0,"score":0,"rank":0,"prefColumns":0,"artifacts":[{"id":0,"albumId":0,"artifactId":0,"description":"String","createdDate":"0001-01-01T00:00:00","modifiedDate":"0001-01-01T00:00:00","artifact":{"id":0,"creativeId":0,"fileName":"String","filePath":"String","contentType":"String","contentLength":0,"width":0,"height":0,"seed":0,"prompt":"String","nsfw":false,"averageHash":0,"perceptualHash":0,"differenceHash":0,"background":"String","lqip":"String","quality":0,"likesCount":0,"albumsCount":0,"downloadsCount":0,"searchCount":0,"temporalScore":0,"score":0,"rank":0,"refId":"String","versions":{"String":"String"},"createdDate":"0001-01-01T00:00:00","createdBy":"String","modifiedDate":"0001-01-01T00:00:00","modifiedBy":"String","deletedDate":"0001-01-01T00:00:00","deletedBy":"String"}}],"createdDate":"0001-01-01T00:00:00","createdBy":"String","modifiedDate":"0001-01-01T00:00:00","modifiedBy":"String","deletedDate":"0001-01-01T00:00:00","deletedBy":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}