// @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); }
}
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;
// @Ignore()
public userProfileUrl: string;
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); }
}
export class QueryPosts extends QueryDb<Post>
{
public ids?: number[];
public organizationId?: number;
public organizationIds?: number[];
public types?: string[];
public anyTechnologyIds?: number[];
public is?: string[];
public userId?: number;
public constructor(init?: Partial<QueryPosts>) { 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: 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); }
}
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 /jsv/reply/QueryPosts HTTP/1.1
Host: techstacks.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ids:
[
0
],
organizationId: 0,
organizationIds:
[
0
],
types:
[
String
],
anyTechnologyIds:
[
0
],
is:
[
String
],
userId: 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,
organizationId: 0,
userId: 0,
userProfileUrl: String,
type: Announcement,
categoryId: 0,
title: String,
slug: String,
url: String,
imageUrl: String,
content: String,
contentHtml: String,
pinCommentId: 0,
technologyIds:
[
0
],
fromDate: 0001-01-01,
toDate: 0001-01-01,
location: String,
metaType: String,
meta: String,
approved: False,
upVotes: 0,
downVotes: 0,
points: 0,
views: 0,
favorites: 0,
subscribers: 0,
replyCount: 0,
commentsCount: 0,
wordCount: 0,
reportCount: 0,
linksCount: 0,
linkedToCount: 0,
score: 0,
rank: 0,
labels:
[
String
],
refUserIds:
[
0
],
refLinks:
[
String
],
muteUserIds:
[
0
],
lastCommentDate: 0001-01-01,
lastCommentId: 0,
lastCommentUserId: 0,
deleted: 0001-01-01,
deletedBy: String,
locked: 0001-01-01,
lockedBy: String,
hidden: 0001-01-01,
hiddenBy: String,
status: String,
statusDate: 0001-01-01,
statusBy: String,
archived: False,
bumped: 0001-01-01,
created: 0001-01-01,
createdBy: String,
modified: 0001-01-01,
modifiedBy: String,
refId: 0,
refSource: String,
refUrn: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}