TechStacks!

<back to all web services

GetOrganization

Organization
The following routes are available for this service:
GET/orgs/{Id}
"use strict";
export class Organization {
    /** @param {{id?:number,name?:string,slug?:string,description?:string,descriptionHtml?:string,color?:string,textColor?:string,linkColor?:string,backgroundColor?:string,backgroundUrl?:string,logoUrl?:string,heroUrl?:string,lang?:string,defaultPostType?:string,defaultSubscriptionPostTypes?:string[],postTypes?:string[],moderatorPostTypes?:string[],deletePostsWithReportCount?:number,disableInvites?:boolean,upVotes?:number,downVotes?:number,views?:number,favorites?:number,subscribers?:number,commentsCount?:number,postsCount?:number,score?:number,rank?:number,refId?:number,refSource?:string,hidden?:string,hiddenBy?:string,locked?:string,lockedBy?:string,deleted?:string,deletedBy?:string,created?:string,createdBy?:string,modified?:string,modifiedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    name;
    /** @type {string} */
    slug;
    /** @type {string} */
    description;
    /** @type {string} */
    descriptionHtml;
    /** @type {string} */
    color;
    /** @type {string} */
    textColor;
    /** @type {string} */
    linkColor;
    /** @type {string} */
    backgroundColor;
    /** @type {string} */
    backgroundUrl;
    /** @type {string} */
    logoUrl;
    /** @type {string} */
    heroUrl;
    /** @type {string} */
    lang;
    /** @type {string} */
    defaultPostType;
    /** @type {string[]} */
    defaultSubscriptionPostTypes;
    /** @type {string[]} */
    postTypes;
    /** @type {string[]} */
    moderatorPostTypes;
    /** @type {number} */
    deletePostsWithReportCount;
    /** @type {?boolean} */
    disableInvites;
    /** @type {number} */
    upVotes;
    /** @type {number} */
    downVotes;
    /** @type {number} */
    views;
    /** @type {number} */
    favorites;
    /** @type {number} */
    subscribers;
    /** @type {number} */
    commentsCount;
    /** @type {number} */
    postsCount;
    /** @type {number} */
    score;
    /** @type {number} */
    rank;
    /** @type {?number} */
    refId;
    /** @type {string} */
    refSource;
    /** @type {?string} */
    hidden;
    /** @type {string} */
    hiddenBy;
    /** @type {?string} */
    locked;
    /** @type {string} */
    lockedBy;
    /** @type {?string} */
    deleted;
    /** @type {string} */
    deletedBy;
    /** @type {string} */
    created;
    /** @type {string} */
    createdBy;
    /** @type {string} */
    modified;
    /** @type {string} */
    modifiedBy;
}
export class OrganizationLabel {
    /** @param {{slug?:string,organizationId?:number,description?:string,color?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    slug;
    /** @type {number} */
    organizationId;
    /** @type {string} */
    description;
    /** @type {string} */
    color;
}
export class Category {
    /** @param {{id?:number,organizationId?:number,name?:string,slug?:string,description?:string,color?:string,technologyIds?:number[],commentsCount?:number,postsCount?:number,score?:number,rank?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    organizationId;
    /** @type {string} */
    name;
    /** @type {string} */
    slug;
    /** @type {string} */
    description;
    /** @type {string} */
    color;
    /** @type {number[]} */
    technologyIds;
    /** @type {number} */
    commentsCount;
    /** @type {number} */
    postsCount;
    /** @type {number} */
    score;
    /** @type {number} */
    rank;
}
export class OrganizationMember {
    /** @param {{id?:number,organizationId?:number,userId?:number,userName?:string,isOwner?:boolean,isModerator?:boolean,denyAll?:boolean,denyPosts?:boolean,denyComments?:boolean,notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    organizationId;
    /** @type {number} */
    userId;
    /** @type {string} */
    userName;
    /** @type {boolean} */
    isOwner;
    /** @type {boolean} */
    isModerator;
    /** @type {boolean} */
    denyAll;
    /** @type {boolean} */
    denyPosts;
    /** @type {boolean} */
    denyComments;
    /** @type {string} */
    notes;
}
export class GetOrganizationResponse {
    /** @param {{cache?:number,id?:number,slug?:string,organization?:Organization,labels?:OrganizationLabel[],categories?:Category[],owners?:OrganizationMember[],moderators?:OrganizationMember[],membersCount?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    cache;
    /** @type {number} */
    id;
    /** @type {string} */
    slug;
    /** @type {Organization} */
    organization;
    /** @type {OrganizationLabel[]} */
    labels;
    /** @type {Category[]} */
    categories;
    /** @type {OrganizationMember[]} */
    owners;
    /** @type {OrganizationMember[]} */
    moderators;
    /** @type {number} */
    membersCount;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetOrganization {
    /** @param {{id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    id;
}

JavaScript GetOrganization DTOs

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.

GET /orgs/{Id} HTTP/1.1 
Host: techstacks.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	cache: 0,
	id: 0,
	slug: String,
	organization: 
	{
		id: 0,
		name: String,
		slug: String,
		description: String,
		descriptionHtml: String,
		color: String,
		textColor: String,
		linkColor: String,
		backgroundColor: String,
		backgroundUrl: String,
		logoUrl: String,
		heroUrl: String,
		lang: String,
		defaultPostType: String,
		defaultSubscriptionPostTypes: 
		[
			String
		],
		postTypes: 
		[
			String
		],
		moderatorPostTypes: 
		[
			String
		],
		deletePostsWithReportCount: 0,
		disableInvites: False,
		upVotes: 0,
		downVotes: 0,
		views: 0,
		favorites: 0,
		subscribers: 0,
		commentsCount: 0,
		postsCount: 0,
		score: 0,
		rank: 0,
		refId: 0,
		refSource: String,
		hidden: 0001-01-01,
		hiddenBy: String,
		locked: 0001-01-01,
		lockedBy: String,
		deleted: 0001-01-01,
		deletedBy: String,
		created: 0001-01-01,
		createdBy: String,
		modified: 0001-01-01,
		modifiedBy: String
	},
	labels: 
	[
		{
			slug: String,
			organizationId: 0,
			description: String,
			color: String
		}
	],
	categories: 
	[
		{
			id: 0,
			organizationId: 0,
			name: String,
			slug: String,
			description: String,
			color: String,
			technologyIds: 
			[
				0
			],
			commentsCount: 0,
			postsCount: 0,
			score: 0,
			rank: 0
		}
	],
	owners: 
	[
		{
			id: 0,
			organizationId: 0,
			userId: 0,
			userName: String,
			isOwner: False,
			isModerator: False,
			denyAll: False,
			denyPosts: False,
			denyComments: False,
			notes: String
		}
	],
	moderators: 
	[
		{
			id: 0,
			organizationId: 0,
			userId: 0,
			userName: String,
			isOwner: False,
			isModerator: False,
			denyAll: False,
			denyPosts: False,
			denyComments: False,
			notes: String
		}
	],
	membersCount: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}