Blazor Diffusion

QueryAlbums

Albums

**QueryAlbums** Parameters:
Name	Parameter	Data Type	Required	Description
Id	query	int?	No
Ids	query	List<int>	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**Album** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Description	form	string	Yes
Slug	form	string	Yes
Tags	form	List<string>	Yes
RefId	form	string	Yes
OwnerId	form	int	No
OwnerRef	form	string	Yes
PrimaryArtifactId	form	int?	No
Private	form	bool	No
Rating	form	int?	No
LikesCount	form	int	No
DownloadsCount	form	int	No
SearchCount	form	int	No
Score	form	int	No
Rank	form	int	No
PrefColumns	form	int?	No
Artifacts	form	List<AlbumArtifact>	Yes

**AuditBase** Parameters:
Name	Parameter	Data Type	Required
CreatedDate	form	DateTime	No
CreatedBy	form	string	Yes
ModifiedDate	form	DateTime	No
ModifiedBy	form	string	Yes
DeletedDate	form	DateTime?	No
DeletedBy	form	string	No

**AlbumArtifact** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
AlbumId	form	int	No
ArtifactId	form	int	No
Description	form	string	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
Artifact	form	Artifact	No

**Artifact** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CreativeId	form	int	No
FileName	form	string	Yes
FilePath	form	string	Yes
ContentType	form	string	Yes
ContentLength	form	long	No
Width	form	int	No
Height	form	int	No
Seed	form	ulong	No
Prompt	form	string	Yes
Nsfw	form	bool?	No
AverageHash	form	long?	No
PerceptualHash	form	long?	No
DifferenceHash	form	long?	No
Background	form	string	No
Lqip	form	string	No
Quality	form	int	No
LikesCount	form	int	No
AlbumsCount	form	int	No
DownloadsCount	form	int	No
SearchCount	form	int	No
TemporalScore	form	int	No
Score	form	int	No
Rank	form	int	No
RefId	form	string	Yes
Versions	form	Dictionary<string, string>	Yes

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<ArtifactResult>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**ArtifactResult** Parameters:
Name	Parameter	Data Type	Required
UserPrompt	form	string	Yes
ArtistNames	form	List<string>	Yes
ModifierNames	form	List<string>	Yes
PrimaryArtifactId	form	int?	No
OwnerRef	form	string	Yes
Similarity	form	double?	No

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 /jsv/reply/QueryAlbums HTTP/1.1 
Host: blazordiffusion.com 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
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-01,
					modifiedDate: 0001-01-01,
					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-01,
						createdBy: String,
						modifiedDate: 0001-01-01,
						modifiedBy: String,
						deletedDate: 0001-01-01,
						deletedBy: String
					}
				}
			],
			createdDate: 0001-01-01,
			createdBy: String,
			modifiedDate: 0001-01-01,
			modifiedBy: String,
			deletedDate: 0001-01-01,
			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
		}
	}
}