regis

<back to all web services

DropSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Drop/{uuid}/Term/{reporting_term}/Submit
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class DropSubmitRequest implements IConvertible
{
    String? transaction_uuid;
    String? uuid;
    String? reporting_term;
    List<String>? student_section_uuids_to_drop;
    List<int>? rates_opted_in;
    String? authorizing_uuid;

    DropSubmitRequest({this.transaction_uuid,this.uuid,this.reporting_term,this.student_section_uuids_to_drop,this.rates_opted_in,this.authorizing_uuid});
    DropSubmitRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        transaction_uuid = json['transaction_uuid'];
        uuid = json['uuid'];
        reporting_term = json['reporting_term'];
        student_section_uuids_to_drop = JsonConverters.fromJson(json['student_section_uuids_to_drop'],'List<String>',context!);
        rates_opted_in = JsonConverters.fromJson(json['rates_opted_in'],'List<int>',context!);
        authorizing_uuid = json['authorizing_uuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'transaction_uuid': transaction_uuid,
        'uuid': uuid,
        'reporting_term': reporting_term,
        'student_section_uuids_to_drop': JsonConverters.toJson(student_section_uuids_to_drop,'List<String>',context!),
        'rates_opted_in': JsonConverters.toJson(rates_opted_in,'List<int>',context!),
        'authorizing_uuid': authorizing_uuid
    };

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

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

Dart DropSubmitRequest 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 /Registration/Drop/{uuid}/Term/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DropSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <rates_opted_in xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </rates_opted_in>
  <reporting_term>String</reporting_term>
  <student_section_uuids_to_drop xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </student_section_uuids_to_drop>
  <transaction_uuid>String</transaction_uuid>
  <uuid>String</uuid>
</DropSubmitRequest>
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>