regis

PersonRestrictionsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Person/{uuid}/Restrictions

import 'package:servicestack/servicestack.dart';

class PersonRestrictionResponse implements IConvertible
{
    int? id;
    String? restriction_code;
    String? restriction_description;
    DateTime? start_date;
    DateTime? end_date;

    PersonRestrictionResponse({this.id,this.restriction_code,this.restriction_description,this.start_date,this.end_date});
    PersonRestrictionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        restriction_code = json['restriction_code'];
        restriction_description = json['restriction_description'];
        start_date = JsonConverters.fromJson(json['start_date'],'DateTime',context!);
        end_date = JsonConverters.fromJson(json['end_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'restriction_code': restriction_code,
        'restriction_description': restriction_description,
        'start_date': JsonConverters.toJson(start_date,'DateTime',context!),
        'end_date': JsonConverters.toJson(end_date,'DateTime',context!)
    };

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

class RestrictionResponse implements IConvertible
{
    int? id;
    String? restriction_code;
    String? restriction_description;
    bool? is_active;

    RestrictionResponse({this.id,this.restriction_code,this.restriction_description,this.is_active});
    RestrictionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        restriction_code = json['restriction_code'];
        restriction_description = json['restriction_description'];
        is_active = json['is_active'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'restriction_code': restriction_code,
        'restriction_description': restriction_description,
        'is_active': is_active
    };

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

class PersonRestrictionsResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? uuid;
    List<PersonRestrictionResponse>? restrictions;
    List<RestrictionResponse>? valid_restrictions;

    PersonRestrictionsResponse({this.responseStatus,this.regent_id,this.uuid,this.restrictions,this.valid_restrictions});
    PersonRestrictionsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        uuid = json['uuid'];
        restrictions = JsonConverters.fromJson(json['restrictions'],'List<PersonRestrictionResponse>',context!);
        valid_restrictions = JsonConverters.fromJson(json['valid_restrictions'],'List<RestrictionResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'uuid': uuid,
        'restrictions': JsonConverters.toJson(restrictions,'List<PersonRestrictionResponse>',context!),
        'valid_restrictions': JsonConverters.toJson(valid_restrictions,'List<RestrictionResponse>',context!)
    };

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

class PersonRestrictionsRequest implements IConvertible
{
    String? uuid;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'PersonRestrictionResponse': TypeInfo(TypeOf.Class, create:() => PersonRestrictionResponse()),
    'RestrictionResponse': TypeInfo(TypeOf.Class, create:() => RestrictionResponse()),
    'PersonRestrictionsResponse': TypeInfo(TypeOf.Class, create:() => PersonRestrictionsResponse()),
    'List<PersonRestrictionResponse>': TypeInfo(TypeOf.Class, create:() => <PersonRestrictionResponse>[]),
    'List<RestrictionResponse>': TypeInfo(TypeOf.Class, create:() => <RestrictionResponse>[]),
    'PersonRestrictionsRequest': TypeInfo(TypeOf.Class, create:() => PersonRestrictionsRequest()),
});

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

<PersonRestrictionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</PersonRestrictionsRequest>

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

<PersonRestrictionsResponse 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>
  <regent_id>0</regent_id>
  <restrictions>
    <PersonRestrictionResponse>
      <end_date>0001-01-01T00:00:00</end_date>
      <id>0</id>
      <restriction_code>String</restriction_code>
      <restriction_description>String</restriction_description>
      <start_date>0001-01-01T00:00:00</start_date>
    </PersonRestrictionResponse>
  </restrictions>
  <uuid>String</uuid>
  <valid_restrictions>
    <RestrictionResponse>
      <id>0</id>
      <is_active>false</is_active>
      <restriction_code>String</restriction_code>
      <restriction_description>String</restriction_description>
    </RestrictionResponse>
  </valid_restrictions>
</PersonRestrictionsResponse>