Jump to: navigation, search

GetAllGroups

Purpose

This method is intended for downloading of all PII Groups in specific tenant/SubscriberId.

URL

  • GET /OMResponse/GetAllGroups/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
TenantId Integer The tenant ID of Groups to retrieve true true
SubscriberId String The subscriber (that is, line of business) within the tenant false true

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
Groups KVList List of groups false true


Group KVList

Key ValueType Value Description Mandatory Unique Default
(GroupId) KVList ID of the group false true


GroupId KVList

Key ValueType Value Description Mandatory Unique Default
Name String 255 chars max Name of the group true true
Description String 255 chars max Description of the group true true
Type String 16 chars max Type of the group true true
CategoryId String 16 chars false true


Error

FaultCode FaultString Description
732 Invalid Tenant {1} Provided tenant is not configured in UCS

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.