regis

<back to all web services

PersonKeyRequest

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

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 PersonKeyRequest implements IConvertible
{
    int? regent_id;
    String? uuid;
    String? regent_login;
    String? regent_network_login;

    PersonKeyRequest({this.regent_id,this.uuid,this.regent_login,this.regent_network_login});
    PersonKeyRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        regent_id = json['regent_id'];
        uuid = json['uuid'];
        regent_login = json['regent_login'];
        regent_network_login = json['regent_network_login'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'regent_id': regent_id,
        'uuid': uuid,
        'regent_login': regent_login,
        'regent_network_login': regent_network_login
    };

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

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

Dart PersonKeyRequest 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 /person/keys HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<PersonKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <re_id>0</re_id>
  <regent_id>0</regent_id>
  <regent_login>String</regent_login>
  <student_id>0</student_id>
  <sugar_id>String</sugar_id>
  <uuid>String</uuid>
</PersonKeyResponse>