regis

<back to all web services

InstitutionRelationshipsUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/{institution_id}/UpdateRelationships
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class InstitutionRelationshipRequest implements IConvertible
{
    int? related_institution_id;
    String? relationship_type;
    String? notes;

    InstitutionRelationshipRequest({this.related_institution_id,this.relationship_type,this.notes});
    InstitutionRelationshipRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'related_institution_id': related_institution_id,
        'relationship_type': relationship_type,
        'notes': notes
    };

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

class InstitutionRelationshipsUpdateRequest implements IConvertible
{
    int? institution_id;
    List<InstitutionRelationshipRequest>? related_institutions;
    String? authorizing_uuid;

    InstitutionRelationshipsUpdateRequest({this.institution_id,this.related_institutions,this.authorizing_uuid});
    InstitutionRelationshipsUpdateRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        institution_id = json['institution_id'];
        related_institutions = JsonConverters.fromJson(json['related_institutions'],'List<InstitutionRelationshipRequest>',context!);
        authorizing_uuid = json['authorizing_uuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'institution_id': institution_id,
        'related_institutions': JsonConverters.toJson(related_institutions,'List<InstitutionRelationshipRequest>',context!),
        'authorizing_uuid': authorizing_uuid
    };

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

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

Dart InstitutionRelationshipsUpdateRequest 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 /Academic/Institution/{institution_id}/UpdateRelationships HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InstitutionRelationshipsUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <institution_id>0</institution_id>
  <related_institutions>
    <InstitutionRelationshipRequest>
      <notes>String</notes>
      <related_institution_id>0</related_institution_id>
      <relationship_type>String</relationship_type>
    </InstitutionRelationshipRequest>
  </related_institutions>
</InstitutionRelationshipsUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>