GET api/ng/circle/getcircleinfo/{CircleID}/{CircleHKey}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CircleID

integer

Required

CircleHKey

string

Required

Body Parameters

None.

Response Information

Resource Description

UserCircle
NameDescriptionTypeAdditional information
CircleUserID

integer

None.

CircleID

integer

None.

IsAdmin

boolean

None.

ApprovalRequestedDate

date

None.

IsApproved

boolean

None.

ApprovedByOUserId

string

None.

IsSuspended

boolean

None.

SuspendDate

date

None.

SuspendedByOUserId

string

None.

SuspendReason

string

None.

Title

string

None.

Description

string

None.

HeaderURL

string

None.

PictureURL

string

None.

HeaderColor

string

None.

PostAdminApproval

boolean

None.

UserAdminApproval

boolean

None.

IsPublicCircle

boolean

None.

IsProgramCircle

boolean

None.

HKey

string

None.

CircleDateCreated

date

None.

NewPostCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "CircleUserID": 1,
  "CircleID": 2,
  "IsAdmin": true,
  "ApprovalRequestedDate": "2021-04-19T20:11:33.2168637-04:00",
  "IsApproved": true,
  "ApprovedByOUserId": "sample string 5",
  "IsSuspended": true,
  "SuspendDate": "2021-04-19T20:11:33.2168637-04:00",
  "SuspendedByOUserId": "sample string 7",
  "SuspendReason": "sample string 8",
  "Title": "sample string 9",
  "Description": "sample string 10",
  "HeaderURL": "sample string 11",
  "PictureURL": "sample string 12",
  "HeaderColor": "sample string 13",
  "PostAdminApproval": true,
  "UserAdminApproval": true,
  "IsPublicCircle": true,
  "IsProgramCircle": true,
  "HKey": "sample string 18",
  "CircleDateCreated": "2021-04-19T20:11:33.2168637-04:00",
  "NewPostCount": 19
}

application/xml, text/xml

Sample:
<UserCircle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SoulSeasons2017.Models.Angular">
  <ApprovalRequestedDate>2021-04-19T20:11:33.2168637-04:00</ApprovalRequestedDate>
  <ApprovedByOUserId>sample string 5</ApprovedByOUserId>
  <CircleDateCreated>2021-04-19T20:11:33.2168637-04:00</CircleDateCreated>
  <CircleID>2</CircleID>
  <CircleUserID>1</CircleUserID>
  <Description>sample string 10</Description>
  <HKey>sample string 18</HKey>
  <HeaderColor>sample string 13</HeaderColor>
  <HeaderURL>sample string 11</HeaderURL>
  <IsAdmin>true</IsAdmin>
  <IsApproved>true</IsApproved>
  <IsProgramCircle>true</IsProgramCircle>
  <IsPublicCircle>true</IsPublicCircle>
  <IsSuspended>true</IsSuspended>
  <NewPostCount>19</NewPostCount>
  <PictureURL>sample string 12</PictureURL>
  <PostAdminApproval>true</PostAdminApproval>
  <SuspendDate>2021-04-19T20:11:33.2168637-04:00</SuspendDate>
  <SuspendReason>sample string 8</SuspendReason>
  <SuspendedByOUserId>sample string 7</SuspendedByOUserId>
  <Title>sample string 9</Title>
  <UserAdminApproval>true</UserAdminApproval>
</UserCircle>