DigiOffice Gateway Web Services

<back to all web services

GetUserConfig

Requires Authentication
The following routes are available for this service:
GET/api/users/me/config
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class Permissions implements IConvertible
{
    bool? DefaultGridProfiles;

    Permissions({this.DefaultGridProfiles});
    Permissions.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DefaultGridProfiles = json['DefaultGridProfiles'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DefaultGridProfiles': DefaultGridProfiles
    };

    getTypeName() => "Permissions";
    TypeContext? context = _ctx;
}

class UserConfig implements IConvertible
{
    String? Theme;
    String? ZoomLevel;
    String? InterfaceCulture;
    bool? Autocomplete;
    Permissions? Permissions;

    UserConfig({this.Theme,this.ZoomLevel,this.InterfaceCulture,this.Autocomplete,this.Permissions});
    UserConfig.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Theme = json['Theme'];
        ZoomLevel = json['ZoomLevel'];
        InterfaceCulture = json['InterfaceCulture'];
        Autocomplete = json['Autocomplete'];
        Permissions = JsonConverters.fromJson(json['Permissions'],'Permissions',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Theme': Theme,
        'ZoomLevel': ZoomLevel,
        'InterfaceCulture': InterfaceCulture,
        'Autocomplete': Autocomplete,
        'Permissions': JsonConverters.toJson(Permissions,'Permissions',context!)
    };

    getTypeName() => "UserConfig";
    TypeContext? context = _ctx;
}

class GetUserConfig implements IConvertible
{
    GetUserConfig();
    GetUserConfig.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "GetUserConfig";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'Permissions': TypeInfo(TypeOf.Class, create:() => Permissions()),
    'UserConfig': TypeInfo(TypeOf.Class, create:() => UserConfig()),
    'GetUserConfig': TypeInfo(TypeOf.Class, create:() => GetUserConfig()),
});

Dart GetUserConfig 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.

GET /api/users/me/config HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.UserInformation">
  <Autocomplete>false</Autocomplete>
  <InterfaceCulture>String</InterfaceCulture>
  <Permissions>
    <DefaultGridProfiles>false</DefaultGridProfiles>
  </Permissions>
  <Theme>String</Theme>
  <ZoomLevel>String</ZoomLevel>
</UserConfig>