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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetOrganizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechStacks.ServiceModel"> <Cache>0</Cache> <Categories xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechStacks.ServiceModel.Types"> <d2p1:Category> <d2p1:Color>String</d2p1:Color> <d2p1:CommentsCount>0</d2p1:CommentsCount> <d2p1:Description>String</d2p1:Description> <d2p1:Id>0</d2p1:Id> <d2p1:Name>String</d2p1:Name> <d2p1:OrganizationId>0</d2p1:OrganizationId> <d2p1:PostsCount>0</d2p1:PostsCount> <d2p1:Rank>0</d2p1:Rank> <d2p1:Score>0</d2p1:Score> <d2p1:Slug>String</d2p1:Slug> <d2p1:TechnologyIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>0</d4p1:int> </d2p1:TechnologyIds> </d2p1:Category> </Categories> <Id>0</Id> <Labels xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechStacks.ServiceModel.Types"> <d2p1:OrganizationLabel> <d2p1:Color>String</d2p1:Color> <d2p1:Description>String</d2p1:Description> <d2p1:OrganizationId>0</d2p1:OrganizationId> <d2p1:Slug>String</d2p1:Slug> </d2p1:OrganizationLabel> </Labels> <MembersCount>0</MembersCount> <Moderators xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechStacks.ServiceModel.Types"> <d2p1:OrganizationMember> <d2p1:DenyAll>false</d2p1:DenyAll> <d2p1:DenyComments>false</d2p1:DenyComments> <d2p1:DenyPosts>false</d2p1:DenyPosts> <d2p1:Id>0</d2p1:Id> <d2p1:IsModerator>false</d2p1:IsModerator> <d2p1:IsOwner>false</d2p1:IsOwner> <d2p1:Notes>String</d2p1:Notes> <d2p1:OrganizationId>0</d2p1:OrganizationId> <d2p1:UserId>0</d2p1:UserId> <d2p1:UserName>String</d2p1:UserName> </d2p1:OrganizationMember> </Moderators> <Organization xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechStacks.ServiceModel.Types"> <d2p1:BackgroundColor>String</d2p1:BackgroundColor> <d2p1:BackgroundUrl>String</d2p1:BackgroundUrl> <d2p1:Color>String</d2p1:Color> <d2p1:CommentsCount>0</d2p1:CommentsCount> <d2p1:Created>0001-01-01T00:00:00</d2p1:Created> <d2p1:CreatedBy>String</d2p1:CreatedBy> <d2p1:DefaultPostType>String</d2p1:DefaultPostType> <d2p1:DefaultSubscriptionPostTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1:string> </d2p1:DefaultSubscriptionPostTypes> <d2p1:DeletePostsWithReportCount>0</d2p1:DeletePostsWithReportCount> <d2p1:Deleted>0001-01-01T00:00:00</d2p1:Deleted> <d2p1:DeletedBy>String</d2p1:DeletedBy> <d2p1:Description>String</d2p1:Description> <d2p1:DescriptionHtml>String</d2p1:DescriptionHtml> <d2p1:DisableInvites>false</d2p1:DisableInvites> <d2p1:DownVotes>0</d2p1:DownVotes> <d2p1:Favorites>0</d2p1:Favorites> <d2p1:HeroUrl>String</d2p1:HeroUrl> <d2p1:Hidden>0001-01-01T00:00:00</d2p1:Hidden> <d2p1:HiddenBy>String</d2p1:HiddenBy> <d2p1:Id>0</d2p1:Id> <d2p1:Lang>String</d2p1:Lang> <d2p1:LinkColor>String</d2p1:LinkColor> <d2p1:Locked>0001-01-01T00:00:00</d2p1:Locked> <d2p1:LockedBy>String</d2p1:LockedBy> <d2p1:LogoUrl>String</d2p1:LogoUrl> <d2p1:ModeratorPostTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1:string> </d2p1:ModeratorPostTypes> <d2p1:Modified>0001-01-01T00:00:00</d2p1:Modified> <d2p1:ModifiedBy>String</d2p1:ModifiedBy> <d2p1:Name>String</d2p1:Name> <d2p1:PostTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1:string> </d2p1:PostTypes> <d2p1:PostsCount>0</d2p1:PostsCount> <d2p1:Rank>0</d2p1:Rank> <d2p1:RefId>0</d2p1:RefId> <d2p1:RefSource>String</d2p1:RefSource> <d2p1:Score>0</d2p1:Score> <d2p1:Slug>String</d2p1:Slug> <d2p1:Subscribers>0</d2p1:Subscribers> <d2p1:TextColor>String</d2p1:TextColor> <d2p1:UpVotes>0</d2p1:UpVotes> <d2p1:Views>0</d2p1:Views> </Organization> <Owners xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechStacks.ServiceModel.Types"> <d2p1:OrganizationMember> <d2p1:DenyAll>false</d2p1:DenyAll> <d2p1:DenyComments>false</d2p1:DenyComments> <d2p1:DenyPosts>false</d2p1:DenyPosts> <d2p1:Id>0</d2p1:Id> <d2p1:IsModerator>false</d2p1:IsModerator> <d2p1:IsOwner>false</d2p1:IsOwner> <d2p1:Notes>String</d2p1:Notes> <d2p1:OrganizationId>0</d2p1:OrganizationId> <d2p1:UserId>0</d2p1:UserId> <d2p1:UserName>String</d2p1:UserName> </d2p1:OrganizationMember> </Owners> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1: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> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1: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> </d2p1:Meta> </ResponseStatus> <Slug>String</Slug> </GetOrganizationResponse>