TechStacks!

<back to all web services

GetOrganizationAdmin

Organization
Requires Authentication
The following routes are available for this service:
GET/orgs/{Id}/admin
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class OrganizationLabel implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $slug=null,
        /** @var int */
        public int $organizationId=0,
        /** @var string|null */
        public ?string $description=null,
        /** @var string|null */
        public ?string $color=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['slug'])) $this->slug = $o['slug'];
        if (isset($o['organizationId'])) $this->organizationId = $o['organizationId'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['color'])) $this->color = $o['color'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->slug)) $o['slug'] = $this->slug;
        if (isset($this->organizationId)) $o['organizationId'] = $this->organizationId;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->color)) $o['color'] = $this->color;
        return empty($o) ? new class(){} : $o;
    }
}

class OrganizationMember implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $organizationId=0,
        /** @var int */
        public int $userId=0,
        /** @var string|null */
        public ?string $userName=null,
        /** @var bool|null */
        public ?bool $isOwner=null,
        /** @var bool|null */
        public ?bool $isModerator=null,
        /** @var bool|null */
        public ?bool $denyAll=null,
        /** @var bool|null */
        public ?bool $denyPosts=null,
        /** @var bool|null */
        public ?bool $denyComments=null,
        /** @var string|null */
        public ?string $notes=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['organizationId'])) $this->organizationId = $o['organizationId'];
        if (isset($o['userId'])) $this->userId = $o['userId'];
        if (isset($o['userName'])) $this->userName = $o['userName'];
        if (isset($o['isOwner'])) $this->isOwner = $o['isOwner'];
        if (isset($o['isModerator'])) $this->isModerator = $o['isModerator'];
        if (isset($o['denyAll'])) $this->denyAll = $o['denyAll'];
        if (isset($o['denyPosts'])) $this->denyPosts = $o['denyPosts'];
        if (isset($o['denyComments'])) $this->denyComments = $o['denyComments'];
        if (isset($o['notes'])) $this->notes = $o['notes'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->organizationId)) $o['organizationId'] = $this->organizationId;
        if (isset($this->userId)) $o['userId'] = $this->userId;
        if (isset($this->userName)) $o['userName'] = $this->userName;
        if (isset($this->isOwner)) $o['isOwner'] = $this->isOwner;
        if (isset($this->isModerator)) $o['isModerator'] = $this->isModerator;
        if (isset($this->denyAll)) $o['denyAll'] = $this->denyAll;
        if (isset($this->denyPosts)) $o['denyPosts'] = $this->denyPosts;
        if (isset($this->denyComments)) $o['denyComments'] = $this->denyComments;
        if (isset($this->notes)) $o['notes'] = $this->notes;
        return empty($o) ? new class(){} : $o;
    }
}

class OrganizationMemberInvite implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $organizationId=0,
        /** @var int */
        public int $userId=0,
        /** @var string|null */
        public ?string $userName=null,
        /** @var DateTime|null */
        public ?DateTime $dismissed=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['organizationId'])) $this->organizationId = $o['organizationId'];
        if (isset($o['userId'])) $this->userId = $o['userId'];
        if (isset($o['userName'])) $this->userName = $o['userName'];
        if (isset($o['dismissed'])) $this->dismissed = JsonConverters::from('DateTime', $o['dismissed']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->organizationId)) $o['organizationId'] = $this->organizationId;
        if (isset($this->userId)) $o['userId'] = $this->userId;
        if (isset($this->userName)) $o['userName'] = $this->userName;
        if (isset($this->dismissed)) $o['dismissed'] = JsonConverters::to('DateTime', $this->dismissed);
        return empty($o) ? new class(){} : $o;
    }
}

enum FlagType : string
{
    case Violation = 'Violation';
    case Spam = 'Spam';
    case Abusive = 'Abusive';
    case Confidential = 'Confidential';
    case OffTopic = 'OffTopic';
    case Other = 'Other';
}

class PostReportInfo implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $organizationId=0,
        /** @var int */
        public int $postId=0,
        /** @var int */
        public int $userId=0,
        /** @var string|null */
        public ?string $userName=null,
        /** @var FlagType|null */
        public ?FlagType $flagType=null,
        /** @var string|null */
        public ?string $reportNotes=null,
        /** @var DateTime */
        public DateTime $created=new DateTime(),
        /** @var DateTime|null */
        public ?DateTime $acknowledged=null,
        /** @var string|null */
        public ?string $acknowledgedBy=null,
        /** @var DateTime|null */
        public ?DateTime $dismissed=null,
        /** @var string|null */
        public ?string $dismissedBy=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var int */
        public int $reportCount=0,
        /** @var string|null */
        public ?string $createdBy=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['organizationId'])) $this->organizationId = $o['organizationId'];
        if (isset($o['postId'])) $this->postId = $o['postId'];
        if (isset($o['userId'])) $this->userId = $o['userId'];
        if (isset($o['userName'])) $this->userName = $o['userName'];
        if (isset($o['flagType'])) $this->flagType = JsonConverters::from('FlagType', $o['flagType']);
        if (isset($o['reportNotes'])) $this->reportNotes = $o['reportNotes'];
        if (isset($o['created'])) $this->created = JsonConverters::from('DateTime', $o['created']);
        if (isset($o['acknowledged'])) $this->acknowledged = JsonConverters::from('DateTime', $o['acknowledged']);
        if (isset($o['acknowledgedBy'])) $this->acknowledgedBy = $o['acknowledgedBy'];
        if (isset($o['dismissed'])) $this->dismissed = JsonConverters::from('DateTime', $o['dismissed']);
        if (isset($o['dismissedBy'])) $this->dismissedBy = $o['dismissedBy'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['reportCount'])) $this->reportCount = $o['reportCount'];
        if (isset($o['createdBy'])) $this->createdBy = $o['createdBy'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->organizationId)) $o['organizationId'] = $this->organizationId;
        if (isset($this->postId)) $o['postId'] = $this->postId;
        if (isset($this->userId)) $o['userId'] = $this->userId;
        if (isset($this->userName)) $o['userName'] = $this->userName;
        if (isset($this->flagType)) $o['flagType'] = JsonConverters::to('FlagType', $this->flagType);
        if (isset($this->reportNotes)) $o['reportNotes'] = $this->reportNotes;
        if (isset($this->created)) $o['created'] = JsonConverters::to('DateTime', $this->created);
        if (isset($this->acknowledged)) $o['acknowledged'] = JsonConverters::to('DateTime', $this->acknowledged);
        if (isset($this->acknowledgedBy)) $o['acknowledgedBy'] = $this->acknowledgedBy;
        if (isset($this->dismissed)) $o['dismissed'] = JsonConverters::to('DateTime', $this->dismissed);
        if (isset($this->dismissedBy)) $o['dismissedBy'] = $this->dismissedBy;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->reportCount)) $o['reportCount'] = $this->reportCount;
        if (isset($this->createdBy)) $o['createdBy'] = $this->createdBy;
        return empty($o) ? new class(){} : $o;
    }
}

class PostCommentReportInfo implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $organizationId=0,
        /** @var int */
        public int $postId=0,
        /** @var int */
        public int $postCommentId=0,
        /** @var int */
        public int $userId=0,
        /** @var string|null */
        public ?string $userName=null,
        /** @var FlagType|null */
        public ?FlagType $flagType=null,
        /** @var string|null */
        public ?string $reportNotes=null,
        /** @var DateTime */
        public DateTime $created=new DateTime(),
        /** @var DateTime|null */
        public ?DateTime $acknowledged=null,
        /** @var string|null */
        public ?string $acknowledgedBy=null,
        /** @var DateTime|null */
        public ?DateTime $dismissed=null,
        /** @var string|null */
        public ?string $dismissedBy=null,
        /** @var string|null */
        public ?string $contentHtml=null,
        /** @var int */
        public int $reportCount=0,
        /** @var string|null */
        public ?string $createdBy=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['organizationId'])) $this->organizationId = $o['organizationId'];
        if (isset($o['postId'])) $this->postId = $o['postId'];
        if (isset($o['postCommentId'])) $this->postCommentId = $o['postCommentId'];
        if (isset($o['userId'])) $this->userId = $o['userId'];
        if (isset($o['userName'])) $this->userName = $o['userName'];
        if (isset($o['flagType'])) $this->flagType = JsonConverters::from('FlagType', $o['flagType']);
        if (isset($o['reportNotes'])) $this->reportNotes = $o['reportNotes'];
        if (isset($o['created'])) $this->created = JsonConverters::from('DateTime', $o['created']);
        if (isset($o['acknowledged'])) $this->acknowledged = JsonConverters::from('DateTime', $o['acknowledged']);
        if (isset($o['acknowledgedBy'])) $this->acknowledgedBy = $o['acknowledgedBy'];
        if (isset($o['dismissed'])) $this->dismissed = JsonConverters::from('DateTime', $o['dismissed']);
        if (isset($o['dismissedBy'])) $this->dismissedBy = $o['dismissedBy'];
        if (isset($o['contentHtml'])) $this->contentHtml = $o['contentHtml'];
        if (isset($o['reportCount'])) $this->reportCount = $o['reportCount'];
        if (isset($o['createdBy'])) $this->createdBy = $o['createdBy'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->organizationId)) $o['organizationId'] = $this->organizationId;
        if (isset($this->postId)) $o['postId'] = $this->postId;
        if (isset($this->postCommentId)) $o['postCommentId'] = $this->postCommentId;
        if (isset($this->userId)) $o['userId'] = $this->userId;
        if (isset($this->userName)) $o['userName'] = $this->userName;
        if (isset($this->flagType)) $o['flagType'] = JsonConverters::to('FlagType', $this->flagType);
        if (isset($this->reportNotes)) $o['reportNotes'] = $this->reportNotes;
        if (isset($this->created)) $o['created'] = JsonConverters::to('DateTime', $this->created);
        if (isset($this->acknowledged)) $o['acknowledged'] = JsonConverters::to('DateTime', $this->acknowledged);
        if (isset($this->acknowledgedBy)) $o['acknowledgedBy'] = $this->acknowledgedBy;
        if (isset($this->dismissed)) $o['dismissed'] = JsonConverters::to('DateTime', $this->dismissed);
        if (isset($this->dismissedBy)) $o['dismissedBy'] = $this->dismissedBy;
        if (isset($this->contentHtml)) $o['contentHtml'] = $this->contentHtml;
        if (isset($this->reportCount)) $o['reportCount'] = $this->reportCount;
        if (isset($this->createdBy)) $o['createdBy'] = $this->createdBy;
        return empty($o) ? new class(){} : $o;
    }
}

class GetOrganizationAdminResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<OrganizationLabel>|null */
        public ?array $labels=null,
        /** @var array<OrganizationMember>|null */
        public ?array $members=null,
        /** @var array<OrganizationMemberInvite>|null */
        public ?array $memberInvites=null,
        /** @var array<PostReportInfo>|null */
        public ?array $reportedPosts=null,
        /** @var array<PostCommentReportInfo>|null */
        public ?array $reportedPostComments=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['labels'])) $this->labels = JsonConverters::fromArray('OrganizationLabel', $o['labels']);
        if (isset($o['members'])) $this->members = JsonConverters::fromArray('OrganizationMember', $o['members']);
        if (isset($o['memberInvites'])) $this->memberInvites = JsonConverters::fromArray('OrganizationMemberInvite', $o['memberInvites']);
        if (isset($o['reportedPosts'])) $this->reportedPosts = JsonConverters::fromArray('PostReportInfo', $o['reportedPosts']);
        if (isset($o['reportedPostComments'])) $this->reportedPostComments = JsonConverters::fromArray('PostCommentReportInfo', $o['reportedPostComments']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->labels)) $o['labels'] = JsonConverters::toArray('OrganizationLabel', $this->labels);
        if (isset($this->members)) $o['members'] = JsonConverters::toArray('OrganizationMember', $this->members);
        if (isset($this->memberInvites)) $o['memberInvites'] = JsonConverters::toArray('OrganizationMemberInvite', $this->memberInvites);
        if (isset($this->reportedPosts)) $o['reportedPosts'] = JsonConverters::toArray('PostReportInfo', $this->reportedPosts);
        if (isset($this->reportedPostComments)) $o['reportedPostComments'] = JsonConverters::toArray('PostCommentReportInfo', $this->reportedPostComments);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class GetOrganizationAdmin implements IGet, JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetOrganizationAdmin DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"labels":[{"slug":"String","organizationId":0,"description":"String","color":"String"}],"members":[{"id":0,"organizationId":0,"userId":0,"userName":"String","isOwner":false,"isModerator":false,"denyAll":false,"denyPosts":false,"denyComments":false,"notes":"String"}],"memberInvites":[{"id":0,"organizationId":0,"userId":0,"userName":"String","dismissed":"0001-01-01T00:00:00.0000000"}],"reportedPosts":[{"id":0,"organizationId":0,"postId":0,"userId":0,"userName":"String","flagType":"Violation","reportNotes":"String","created":"0001-01-01T00:00:00.0000000","acknowledged":"0001-01-01T00:00:00.0000000","acknowledgedBy":"String","dismissed":"0001-01-01T00:00:00.0000000","dismissedBy":"String","title":"String","reportCount":0,"createdBy":"String"}],"reportedPostComments":[{"id":0,"organizationId":0,"postId":0,"postCommentId":0,"userId":0,"userName":"String","flagType":"Violation","reportNotes":"String","created":"0001-01-01T00:00:00.0000000","acknowledged":"0001-01-01T00:00:00.0000000","acknowledgedBy":"String","dismissed":"0001-01-01T00:00:00.0000000","dismissedBy":"String","contentHtml":"String","reportCount":0,"createdBy":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}