regis

<back to all web services

DirectoryBrowseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Browse/{page}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class DirectoryPersonBrowseResponse implements IConvertible
{
    String? directory_uuid;
    String? imageBase64;
    String? name;
    bool? is_active;

    DirectoryPersonBrowseResponse({this.directory_uuid,this.imageBase64,this.name,this.is_active});
    DirectoryPersonBrowseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        directory_uuid = json['directory_uuid'];
        imageBase64 = json['imageBase64'];
        name = json['name'];
        is_active = json['is_active'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'directory_uuid': directory_uuid,
        'imageBase64': imageBase64,
        'name': name,
        'is_active': is_active
    };

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

class DirectoryBrowseResponse implements IConvertible
{
    List<DirectoryPersonBrowseResponse>? persons;
    int? total_items;
    int? current_page;

    DirectoryBrowseResponse({this.persons,this.total_items,this.current_page});
    DirectoryBrowseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        persons = JsonConverters.fromJson(json['persons'],'List<DirectoryPersonBrowseResponse>',context!);
        total_items = json['total_items'];
        current_page = json['current_page'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'persons': JsonConverters.toJson(persons,'List<DirectoryPersonBrowseResponse>',context!),
        'total_items': total_items,
        'current_page': current_page
    };

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

class DirectoryBrowseRequest implements IConvertible
{
    int? page;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'DirectoryPersonBrowseResponse': TypeInfo(TypeOf.Class, create:() => DirectoryPersonBrowseResponse()),
    'DirectoryBrowseResponse': TypeInfo(TypeOf.Class, create:() => DirectoryBrowseResponse()),
    'List<DirectoryPersonBrowseResponse>': TypeInfo(TypeOf.Class, create:() => <DirectoryPersonBrowseResponse>[]),
    'DirectoryBrowseRequest': TypeInfo(TypeOf.Class, create:() => DirectoryBrowseRequest()),
});

Dart DirectoryBrowseRequest 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 /Directory/Browse/{page} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DirectoryBrowseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <page>0</page>
</DirectoryBrowseRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DirectoryBrowseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <current_page>0</current_page>
  <persons>
    <DirectoryPersonBrowseResponse>
      <directory_uuid>String</directory_uuid>
      <imageBase64>String</imageBase64>
      <is_active>false</is_active>
      <name>String</name>
    </DirectoryPersonBrowseResponse>
  </persons>
  <total_items>0</total_items>
</DirectoryBrowseResponse>