Antel API

GetPrincipleAuthLetters

The following routes are available for this service:
GET	/principal/authletters

import 'package:servicestack/servicestack.dart';

class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, IConvertible
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    String? apiKey;

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    double? latitude;

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    double? longitude;

    ApiServiceRequest({this.apiKey,this.latitude,this.longitude});
    ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiKey = json['apiKey'];
        latitude = JsonConverters.toDouble(json['latitude']);
        longitude = JsonConverters.toDouble(json['longitude']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiKey': apiKey,
        'latitude': latitude,
        'longitude': longitude
    };

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

class ApiServiceResponse implements IServiceResponse, IConvertible
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    String? description;

    /**
    * Heading or summary of the response.
    */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    String? heading;

    /**
    * Did the intended operation for this response complete successfully?
    */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    bool? wasSuccessful;

    ResponseStatus? responseStatus;

    ApiServiceResponse({this.description,this.heading,this.wasSuccessful,this.responseStatus});
    ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'description': description,
        'heading': heading,
        'wasSuccessful': wasSuccessful,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

class PrincipleAuthLetterData implements IConvertible
{
    String? logo;
    String? authLetter;
    String? principleName;
    String? fileName;

    PrincipleAuthLetterData({this.logo,this.authLetter,this.principleName,this.fileName});
    PrincipleAuthLetterData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        logo = json['logo'];
        authLetter = json['authLetter'];
        principleName = json['principleName'];
        fileName = json['fileName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'logo': logo,
        'authLetter': authLetter,
        'principleName': principleName,
        'fileName': fileName
    };

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

class GetPrincipleAuthLettersResponse extends ApiServiceResponse implements IConvertible
{
    List<PrincipleAuthLetterData>? authLetters;

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

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        authLetters = JsonConverters.fromJson(json['authLetters'],'List<PrincipleAuthLetterData>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'authLetters': JsonConverters.toJson(authLetters,'List<PrincipleAuthLetterData>',context!)
    });

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

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

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "GetPrincipleAuthLetters";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'antel.api.dev.86degrees.com', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'PrincipleAuthLetterData': TypeInfo(TypeOf.Class, create:() => PrincipleAuthLetterData()),
    'GetPrincipleAuthLettersResponse': TypeInfo(TypeOf.Class, create:() => GetPrincipleAuthLettersResponse()),
    'List<PrincipleAuthLetterData>': TypeInfo(TypeOf.Class, create:() => <PrincipleAuthLetterData>[]),
    'GetPrincipleAuthLetters': TypeInfo(TypeOf.Class, create:() => GetPrincipleAuthLetters()),
});

Dart GetPrincipleAuthLetters DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /principal/authletters HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/json

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

{"authLetters":[{"logo":"String","authLetter":"String","principleName":"String","fileName":"String"}],"description":"String","heading":"String","wasSuccessful":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}