DigiOffice Gateway Web Services

GetUsersAndGroups


export class UserOrGroup
{
    public ID?: number;
    public Title?: string;
    public IsChecked?: boolean;
    public Image?: string;

    public constructor(init?: Partial<UserOrGroup>) { (Object as any).assign(this, init); }
}

export class QuickAddOption
{
    public Name?: string;
    public EntityType?: string;

    public constructor(init?: Partial<QuickAddOption>) { (Object as any).assign(this, init); }
}

export class UsersOrGroupsResponse implements IBaseQuickLookupResponse
{
    public NumberOfAllRecords?: number;
    public UsersOrGroups?: UserOrGroup[];
    public QuickAddOptions?: QuickAddOption[];

    public constructor(init?: Partial<UsersOrGroupsResponse>) { (Object as any).assign(this, init); }
}

export class GetUsersAndGroups
{
    public UserEnvironment?: number;
    public PageSize?: number;
    public PageNumber?: number;
    public SearchCriteria?: string;
    public SelectedUserIDs?: number[];
    public SelectedGroupIDs?: number[];

    public constructor(init?: Partial<GetUsersAndGroups>) { (Object as any).assign(this, init); }
}

TypeScript GetUsersAndGroups DTOs

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

HTTP + XML

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

POST /xml/reply/GetUsersAndGroups HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetUsersAndGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.UserInformation.Operations">
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <SearchCriteria>String</SearchCriteria>
  <SelectedGroupIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </SelectedGroupIDs>
  <SelectedUserIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </SelectedUserIDs>
  <UserEnvironment>0</UserEnvironment>
</GetUsersAndGroups>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersOrGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.UserInformation">
  <NumberOfAllRecords>0</NumberOfAllRecords>
  <QuickAddOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Controls.QuickLookup">
    <d2p1:QuickAddOption>
      <d2p1:EntityType>String</d2p1:EntityType>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:QuickAddOption>
  </QuickAddOptions>
  <UsersOrGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO">
    <d2p1:UserOrGroup i:nil="true" />
  </UsersOrGroups>
</UsersOrGroupsResponse>