RetrieveGroups

LibraryService / RetrieveGroups

Description: Retrieve groups by queries

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

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
groupids	int[]	True	comma separated values, eg. groupids=1,2,3
name	string	True	name
page	int	True	page number
allaccounts	boolean	True	include all accessible accounts, eg. allaccounts=true
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/libraries/groups?groupids=1,2,3&name=string&page=100

Response:

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

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

Enums:

Field	Name	Values
Operation	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

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>
  <Groups xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Contents">
    <a:Group>
      <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
      <a:Id>123</a:Id>
      <a:IsRootShare>true</a:IsRootShare>
      <a:IsShare>true</a:IsShare>
      <a:IsShared>true</a:IsShared>
      <a:LastUpdate>2015-08-25T17:17:39.6690743Z</a:LastUpdate>
      <a:Metadata xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
        <b:KeyValuePair>
          <b:Key>String</b:Key>
          <b:Value>String</b:Value>
        </b:KeyValuePair>
      </a:Metadata>
      <a:Name>String</a:Name>
      <a:Operation>Special</a:Operation>
      <a:ParentId>123</a:ParentId>
      <a:SharedGroupId>123</a:SharedGroupId>
    </a:Group>
  </Groups>
  <Rpp>123</Rpp>
  <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,
	"Groups":[
		{
			"Guid":"11111111-1111-1111-1111-111111111111",
			"Id":123,
			"IsRootShare":true,
			"IsShare":true,
			"IsShared":true,
			"LastUpdate":"\/Date(1440523059669)\/",
			"Metadata":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"Name":"String",
			"Operation":14,
			"ParentId":123,
			"SharedGroupId":123
		}
	],
	"Rpp":123,
	"TotalPages":123
}