All Verbs | /techstacks/query |
---|
// @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<From, Into> extends QueryBase
{
public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}
export class TechnologyStackView
{
public id?: number;
public name: string;
public vendorName: string;
public description: string;
public appUrl: string;
public screenshotUrl: string;
public created?: string;
public createdBy: string;
public lastModified?: string;
public lastModifiedBy: string;
public isLocked?: boolean;
public ownerId: string;
public slug: string;
public details: string;
public detailsHtml: string;
public lastStatusUpdate?: string;
public organizationId?: number;
public commentsPostId?: number;
public viewCount?: number;
public favCount?: number;
public constructor(init?: Partial<TechnologyStackView>) { (Object as any).assign(this, init); }
}
export class TechnologyStackBase
{
public id: number;
public name: string;
public vendorName: string;
public description: string;
public appUrl: string;
public screenshotUrl: string;
public created: string;
public createdBy: string;
public lastModified: string;
public lastModifiedBy: string;
public isLocked: boolean;
public ownerId: string;
public slug: string;
// @StringLength(2147483647)
public details: string;
// @StringLength(2147483647)
public detailsHtml: string;
public lastStatusUpdate?: string;
public organizationId?: number;
public commentsPostId?: number;
public viewCount: number;
public favCount: number;
public constructor(init?: Partial<TechnologyStackBase>) { (Object as any).assign(this, init); }
}
export class TechnologyStack extends TechnologyStackBase
{
public constructor(init?: Partial<TechnologyStack>) { super(init); (Object as any).assign(this, init); }
}
export class QueryTechStacks extends QueryDb<TechnologyStack, TechnologyStackView>
{
public ids: number[];
public name: string;
public vendorName: string;
public nameContains: string;
public vendorNameContains: string;
public descriptionContains: string;
public constructor(init?: Partial<QueryTechStacks>) { super(init); (Object as any).assign(this, init); }
}
export enum PostType
{
Announcement = 'Announcement',
Post = 'Post',
Showcase = 'Showcase',
Question = 'Question',
Request = 'Request',
}
export class Post
{
public id: number;
public organizationId: number;
public userId: number;
public type: PostType;
public categoryId: number;
public title: string;
public slug: string;
public url: string;
public imageUrl: string;
// @StringLength(2147483647)
public content: string;
// @StringLength(2147483647)
public contentHtml: string;
public pinCommentId?: number;
public technologyIds: number[];
public fromDate?: string;
public toDate?: string;
public location: string;
public metaType: string;
public meta: string;
public approved: boolean;
public upVotes: number;
public downVotes: number;
public points: number;
public views: number;
public favorites: number;
public subscribers: number;
public replyCount: number;
public commentsCount: number;
public wordCount: number;
public reportCount: number;
public linksCount: number;
public linkedToCount: number;
public score: number;
public rank: number;
public labels: string[];
public refUserIds: number[];
public refLinks: string[];
public muteUserIds: number[];
public lastCommentDate?: string;
public lastCommentId?: number;
public lastCommentUserId?: number;
public deleted?: string;
public deletedBy: string;
public locked?: string;
public lockedBy: string;
public hidden?: string;
public hiddenBy: string;
public status: string;
public statusDate?: string;
public statusBy: string;
public archived: boolean;
public bumped?: string;
public created: string;
public createdBy: string;
public modified: string;
public modifiedBy: string;
public refId?: number;
public refSource: string;
public refUrn: string;
public constructor(init?: Partial<Post>) { (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: Post[];
// @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 QueryTechStacks DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ids:
[
0
],
name: String,
vendorName: String,
nameContains: String,
vendorNameContains: String,
descriptionContains: String,
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, vendorName: String, description: String, appUrl: String, screenshotUrl: String, created: 0001-01-01, createdBy: String, lastModified: 0001-01-01, lastModifiedBy: String, isLocked: False, ownerId: String, slug: String, details: String, detailsHtml: String, lastStatusUpdate: 0001-01-01, organizationId: 0, commentsPostId: 0, viewCount: 0, favCount: 0 } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }