Blazor Diffusion

<back to all web services

QueryAlbumArtifacts

Albums
Requires Authentication
Required role:Moderator
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
AlbumArtifact Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
AlbumIdformintNo
ArtifactIdformintNo
DescriptionformstringNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
ArtifactformArtifactNo
Artifact Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CreativeIdformintNo
FileNameformstringYes
FilePathformstringYes
ContentTypeformstringYes
ContentLengthformlongNo
WidthformintNo
HeightformintNo
SeedformulongNo
PromptformstringYes
Nsfwformbool?No
AverageHashformlong?No
PerceptualHashformlong?No
DifferenceHashformlong?No
BackgroundformstringNo
LqipformstringNo
QualityformintNo
LikesCountformintNo
AlbumsCountformintNo
DownloadsCountformintNo
SearchCountformintNo
TemporalScoreformintNo
ScoreformintNo
RankformintNo
RefIdformstringYes
VersionsformDictionary<string, string>Yes
AuditBase Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
CreatedByformstringYes
ModifiedDateformDateTimeNo
ModifiedByformstringYes
DeletedDateformDateTime?No
DeletedByformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<ArtifactResult>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
ArtifactResult Parameters:
NameParameterData TypeRequiredDescription
UserPromptformstringYes
ArtistNamesformList<string>Yes
ModifierNamesformList<string>Yes
PrimaryArtifactIdformint?No
OwnerRefformstringYes
Similarityformdouble?No

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

HTTP + XML

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

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

<QueryAlbumArtifacts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlazorDiffusion.ServiceModel">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</QueryAlbumArtifacts>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfAlbumArtifact55quYL7_S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BlazorDiffusion.ServiceModel">
    <d2p1:AlbumArtifact>
      <d2p1:AlbumId>0</d2p1:AlbumId>
      <d2p1:Artifact>
        <CreatedDate>0001-01-01T00:00:00</CreatedDate>
        <CreatedBy>String</CreatedBy>
        <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
        <ModifiedBy>String</ModifiedBy>
        <DeletedDate>0001-01-01T00:00:00</DeletedDate>
        <DeletedBy>String</DeletedBy>
        <d2p1:AlbumsCount>0</d2p1:AlbumsCount>
        <d2p1:AverageHash>0</d2p1:AverageHash>
        <d2p1:Background>String</d2p1:Background>
        <d2p1:ContentLength>0</d2p1:ContentLength>
        <d2p1:ContentType>String</d2p1:ContentType>
        <d2p1:CreativeId>0</d2p1:CreativeId>
        <d2p1:DifferenceHash>0</d2p1:DifferenceHash>
        <d2p1:DownloadsCount>0</d2p1:DownloadsCount>
        <d2p1:FileName>String</d2p1:FileName>
        <d2p1:FilePath>String</d2p1:FilePath>
        <d2p1:Height>0</d2p1:Height>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:LikesCount>0</d2p1:LikesCount>
        <d2p1:Lqip>String</d2p1:Lqip>
        <d2p1:Nsfw>false</d2p1:Nsfw>
        <d2p1:PerceptualHash>0</d2p1:PerceptualHash>
        <d2p1:Prompt>String</d2p1:Prompt>
        <d2p1:Quality>0</d2p1:Quality>
        <d2p1:Rank>0</d2p1:Rank>
        <d2p1:RefId>String</d2p1:RefId>
        <d2p1:Score>0</d2p1:Score>
        <d2p1:SearchCount>0</d2p1:SearchCount>
        <d2p1:Seed>0</d2p1:Seed>
        <d2p1:TemporalScore>0</d2p1:TemporalScore>
        <d2p1:Versions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Versions>
        <d2p1:Width>0</d2p1:Width>
      </d2p1:Artifact>
      <d2p1:ArtifactId>0</d2p1:ArtifactId>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
    </d2p1:AlbumArtifact>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfAlbumArtifact55quYL7_S>