RetrieveSharedGroups

LibraryService / RetrieveSharedGroups

Description: Retrieve groups by queries

URL: http://{your-server-url}/api/v1/core/libraries/sharedgroups

Method: GET

Token Required: True

Request Headers:

currentuserid: {switch to user id}
content-type: application/json or content-type: application/xml
token: {token}

Required Roles:

Portal Administrator, Account Administrator, Account Owner, Content Administrator, Content Manager, Widget Manager

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right	Require
Content_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
sharedgroupids	int[]	True	comma separated values, eg. sharedgroupids=1,2,3
groupids	int[]	True	comma separated values, eg. groupids=1,2,3
resourcescopes	string[]	True	comma separated values, eg. resourcescopes=portal,networks
resourceids	int[]	True	comma separated values, eg. resourceids=1,2,3
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/libraries/sharedgroups?sharedgroupids=1,2,3&groupids=1,2,3&resourceids=1,2,3

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Library.LibraryResponse

Parameter	Type
Response.Rpp	int
Response.SharedGroups	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Contents.SharedGroup[]
Response.CurrentPage	int
Response.TotalPages	int

Enums:

Field	Name	Values
Permission	Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Operation	Undefined = 0, Read_Only = 2, Read_Only = 2, Write = 4, Modify = 8, Special = 14, Delete = 16, Full_Control = 30
ResourceScope	Nexus.AppSpace.Service.Contract.Model.Enums.Resource.Scope	Undefined = 0, Portal = 1, Account_Groups = 2, Accounts = 3, Networks = 4, Applications = 5, Players = 6, User_Groups = 7, Users = 8, Zones = 9, DataSources = 10, ContentSize = 11, Server = 12, Content = 13, Campaign = 14, Client = 15, Site = 16, Widget = 17, LayoutSchedule = 18, CampaignEntity = 19, ContentFolders = 20, Layouts = 21, MediaZone = 22, Player_Groups = 23, Space = 24

The following is an example response Xml body:

<LibraryResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Library" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <SharedGroups xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Contents">
    <a:SharedGroup>
      <a:GroupId>123</a:GroupId>
      <a:Id>123</a:Id>
      <a:IsRecursive>true</a:IsRecursive>
      <a:Permission>Special</a:Permission>
      <a:ResourceId>123</a:ResourceId>
      <a:ResourceScope>Space</a:ResourceScope>
    </a:SharedGroup>
  </SharedGroups>
  <TotalPages>123</TotalPages>
</LibraryResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"SharedGroups":[
		{
			"GroupId":123,
			"Id":123,
			"IsRecursive":true,
			"Permission":14,
			"ResourceId":123,
			"ResourceScope":24
		}
	],
	"TotalPages":123
}