All Verbs | /techstacks/query |
---|
"use strict";
export class QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
skip;
/** @type {?number} */
take;
/** @type {string} */
orderBy;
/** @type {string} */
orderByDesc;
/** @type {string} */
include;
/** @type {string} */
fields;
/** @type {{ [index:string]: string; }} */
meta;
}
/** @typedef From {any} */
/** @typedef Into {any} */
export class QueryDb extends QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class TechnologyStackView {
/** @param {{id?:number,name?:string,vendorName?:string,description?:string,appUrl?:string,screenshotUrl?:string,created?:string,createdBy?:string,lastModified?:string,lastModifiedBy?:string,isLocked?:boolean,ownerId?:string,slug?:string,details?:string,detailsHtml?:string,lastStatusUpdate?:string,organizationId?:number,commentsPostId?:number,viewCount?:number,favCount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
id;
/** @type {string} */
name;
/** @type {string} */
vendorName;
/** @type {string} */
description;
/** @type {string} */
appUrl;
/** @type {string} */
screenshotUrl;
/** @type {?string} */
created;
/** @type {string} */
createdBy;
/** @type {?string} */
lastModified;
/** @type {string} */
lastModifiedBy;
/** @type {?boolean} */
isLocked;
/** @type {string} */
ownerId;
/** @type {string} */
slug;
/** @type {string} */
details;
/** @type {string} */
detailsHtml;
/** @type {?string} */
lastStatusUpdate;
/** @type {?number} */
organizationId;
/** @type {?number} */
commentsPostId;
/** @type {?number} */
viewCount;
/** @type {?number} */
favCount;
}
export class TechnologyStackBase {
/** @param {{id?:number,name?:string,vendorName?:string,description?:string,appUrl?:string,screenshotUrl?:string,created?:string,createdBy?:string,lastModified?:string,lastModifiedBy?:string,isLocked?:boolean,ownerId?:string,slug?:string,details?:string,detailsHtml?:string,lastStatusUpdate?:string,organizationId?:number,commentsPostId?:number,viewCount?:number,favCount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
name;
/** @type {string} */
vendorName;
/** @type {string} */
description;
/** @type {string} */
appUrl;
/** @type {string} */
screenshotUrl;
/** @type {string} */
created;
/** @type {string} */
createdBy;
/** @type {string} */
lastModified;
/** @type {string} */
lastModifiedBy;
/** @type {boolean} */
isLocked;
/** @type {string} */
ownerId;
/** @type {string} */
slug;
/** @type {string} */
details;
/** @type {string} */
detailsHtml;
/** @type {?string} */
lastStatusUpdate;
/** @type {?number} */
organizationId;
/** @type {?number} */
commentsPostId;
/** @type {number} */
viewCount;
/** @type {number} */
favCount;
}
export class TechnologyStack extends TechnologyStackBase {
/** @param {{id?:number,name?:string,vendorName?:string,description?:string,appUrl?:string,screenshotUrl?:string,created?:string,createdBy?:string,lastModified?:string,lastModifiedBy?:string,isLocked?:boolean,ownerId?:string,slug?:string,details?:string,detailsHtml?:string,lastStatusUpdate?:string,organizationId?:number,commentsPostId?:number,viewCount?:number,favCount?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class QueryTechStacks extends QueryDb {
/** @param {{ids?:number[],name?:string,vendorName?:string,nameContains?:string,vendorNameContains?:string,descriptionContains?:string,skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number[]} */
ids;
/** @type {string} */
name;
/** @type {string} */
vendorName;
/** @type {string} */
nameContains;
/** @type {string} */
vendorNameContains;
/** @type {string} */
descriptionContains;
}
/** @typedef {'Announcement'|'Post'|'Showcase'|'Question'|'Request'} */
export var PostType;
(function (PostType) {
PostType["Announcement"] = "Announcement"
PostType["Post"] = "Post"
PostType["Showcase"] = "Showcase"
PostType["Question"] = "Question"
PostType["Request"] = "Request"
})(PostType || (PostType = {}));
export class Post {
/** @param {{id?:number,organizationId?:number,userId?:number,type?:PostType,categoryId?:number,title?:string,slug?:string,url?:string,imageUrl?:string,content?:string,contentHtml?:string,pinCommentId?:number,technologyIds?:number[],fromDate?:string,toDate?:string,location?:string,metaType?:string,meta?:string,approved?:boolean,upVotes?:number,downVotes?:number,points?:number,views?:number,favorites?:number,subscribers?:number,replyCount?:number,commentsCount?:number,wordCount?:number,reportCount?:number,linksCount?:number,linkedToCount?:number,score?:number,rank?:number,labels?:string[],refUserIds?:number[],refLinks?:string[],muteUserIds?:number[],lastCommentDate?:string,lastCommentId?:number,lastCommentUserId?:number,deleted?:string,deletedBy?:string,locked?:string,lockedBy?:string,hidden?:string,hiddenBy?:string,status?:string,statusDate?:string,statusBy?:string,archived?:boolean,bumped?:string,created?:string,createdBy?:string,modified?:string,modifiedBy?:string,refId?:number,refSource?:string,refUrn?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
organizationId;
/** @type {number} */
userId;
/** @type {PostType} */
type;
/** @type {number} */
categoryId;
/** @type {string} */
title;
/** @type {string} */
slug;
/** @type {string} */
url;
/** @type {string} */
imageUrl;
/** @type {string} */
content;
/** @type {string} */
contentHtml;
/** @type {?number} */
pinCommentId;
/** @type {number[]} */
technologyIds;
/** @type {?string} */
fromDate;
/** @type {?string} */
toDate;
/** @type {string} */
location;
/** @type {string} */
metaType;
/** @type {string} */
meta;
/** @type {boolean} */
approved;
/** @type {number} */
upVotes;
/** @type {number} */
downVotes;
/** @type {number} */
points;
/** @type {number} */
views;
/** @type {number} */
favorites;
/** @type {number} */
subscribers;
/** @type {number} */
replyCount;
/** @type {number} */
commentsCount;
/** @type {number} */
wordCount;
/** @type {number} */
reportCount;
/** @type {number} */
linksCount;
/** @type {number} */
linkedToCount;
/** @type {number} */
score;
/** @type {number} */
rank;
/** @type {string[]} */
labels;
/** @type {number[]} */
refUserIds;
/** @type {string[]} */
refLinks;
/** @type {number[]} */
muteUserIds;
/** @type {?string} */
lastCommentDate;
/** @type {?number} */
lastCommentId;
/** @type {?number} */
lastCommentUserId;
/** @type {?string} */
deleted;
/** @type {string} */
deletedBy;
/** @type {?string} */
locked;
/** @type {string} */
lockedBy;
/** @type {?string} */
hidden;
/** @type {string} */
hiddenBy;
/** @type {string} */
status;
/** @type {?string} */
statusDate;
/** @type {string} */
statusBy;
/** @type {boolean} */
archived;
/** @type {?string} */
bumped;
/** @type {string} */
created;
/** @type {string} */
createdBy;
/** @type {string} */
modified;
/** @type {string} */
modifiedBy;
/** @type {?number} */
refId;
/** @type {string} */
refSource;
/** @type {string} */
refUrn;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{offset?:number,total?:number,results?:T[],meta?:{ [index:string]: string; },responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {number} */
total;
/** @type {T[]} */
results;
/** @type {{ [index:string]: string; }} */
meta;
/** @type {ResponseStatus} */
responseStatus;
}
JavaScript QueryTechStacks DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /techstacks/query HTTP/1.1
Host: techstacks.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<QueryTechStacks xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechStacks.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>
<DescriptionContains>String</DescriptionContains>
<Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>0</d2p1:long>
</Ids>
<Name>String</Name>
<NameContains>String</NameContains>
<VendorName>String</VendorName>
<VendorNameContains>String</VendorNameContains>
</QueryTechStacks>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfTechnologyStackViewclPpLQp2 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/TechStacks.ServiceModel.Types"> <d2p1:TechnologyStackView> <d2p1:AppUrl>String</d2p1:AppUrl> <d2p1:CommentsPostId>0</d2p1:CommentsPostId> <d2p1:Created>0001-01-01T00:00:00</d2p1:Created> <d2p1:CreatedBy>String</d2p1:CreatedBy> <d2p1:Description>String</d2p1:Description> <d2p1:Details>String</d2p1:Details> <d2p1:DetailsHtml>String</d2p1:DetailsHtml> <d2p1:FavCount>0</d2p1:FavCount> <d2p1:Id>0</d2p1:Id> <d2p1:IsLocked>false</d2p1:IsLocked> <d2p1:LastModified>0001-01-01T00:00:00</d2p1:LastModified> <d2p1:LastModifiedBy>String</d2p1:LastModifiedBy> <d2p1:LastStatusUpdate>0001-01-01T00:00:00</d2p1:LastStatusUpdate> <d2p1:Name>String</d2p1:Name> <d2p1:OrganizationId>0</d2p1:OrganizationId> <d2p1:OwnerId>String</d2p1:OwnerId> <d2p1:ScreenshotUrl>String</d2p1:ScreenshotUrl> <d2p1:Slug>String</d2p1:Slug> <d2p1:VendorName>String</d2p1:VendorName> <d2p1:ViewCount>0</d2p1:ViewCount> </d2p1:TechnologyStackView> </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> </QueryResponseOfTechnologyStackViewclPpLQp2>