regis

<back to all web services

PersonKeysRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/keys/all
import 'package:servicestack/servicestack.dart';

class PersonKeyResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    int? re_id;
    String? sugar_id;
    String? uuid;
    int? student_id;
    String? regent_login;

    PersonKeyResponse({this.responseStatus,this.regent_id,this.re_id,this.sugar_id,this.uuid,this.student_id,this.regent_login});
    PersonKeyResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        re_id = json['re_id'];
        sugar_id = json['sugar_id'];
        uuid = json['uuid'];
        student_id = json['student_id'];
        regent_login = json['regent_login'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        're_id': re_id,
        'sugar_id': sugar_id,
        'uuid': uuid,
        'student_id': student_id,
        'regent_login': regent_login
    };

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

class PersonKeysResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    List<PersonKeyResponse>? personKeyResponses;

    PersonKeysResponse({this.responseStatus,this.personKeyResponses});
    PersonKeysResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        personKeyResponses = JsonConverters.fromJson(json['personKeyResponses'],'List<PersonKeyResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'personKeyResponses': JsonConverters.toJson(personKeyResponses,'List<PersonKeyResponse>',context!)
    };

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

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

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

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

Dart PersonKeysRequest DTOs

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

HTTP + CSV

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

POST /person/keys/all HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"personKeyResponses":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"re_id":0,"sugar_id":"String","uuid":"String","student_id":0,"regent_login":"String"}]}