AIM Web Services

<back to all web services

GetCoursesRequest

GetCourses
Requires active-e Tee-Sheet Service

The following routes are available for this service:
GET/api/GetCourses
import 'package:servicestack/servicestack.dart';

// @DataContract
class BaseRequest implements IConvertible
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    String? ApiKey;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    String? OAuthToken;

    BaseRequest({this.ApiKey,this.OAuthToken});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

// @DataContract
class BaseResponseResult implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    String? StatusCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    String? Login;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    String? ErrorCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    String? ErrorDisplayText;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    String? ErrorMessage;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    String? DomainName;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    String? IpAddress;

    BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
    BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StatusCode = json['StatusCode'];
        Login = json['Login'];
        ErrorCode = json['ErrorCode'];
        ErrorDisplayText = json['ErrorDisplayText'];
        ErrorMessage = json['ErrorMessage'];
        DomainName = json['DomainName'];
        IpAddress = json['IpAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StatusCode': StatusCode,
        'Login': Login,
        'ErrorCode': ErrorCode,
        'ErrorDisplayText': ErrorDisplayText,
        'ErrorMessage': ErrorMessage,
        'DomainName': DomainName,
        'IpAddress': IpAddress
    };

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

// @DataContract
class BaseResponse implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    BaseResponseResult? Status;

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

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

    Map<String, dynamic> toJson() => {
        'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
    };

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

// @DataContract
class CourseGeneric implements IConvertible
{
    // @DataMember
    String? Course;

    // @DataMember
    String? CourseTopic;

    // @DataMember
    String? Location;

    // @DataMember
    bool? Has18Holes;

    // @DataMember
    int? OnlineBuffer;

    CourseGeneric({this.Course,this.CourseTopic,this.Location,this.Has18Holes,this.OnlineBuffer});
    CourseGeneric.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Course = json['Course'];
        CourseTopic = json['CourseTopic'];
        Location = json['Location'];
        Has18Holes = json['Has18Holes'];
        OnlineBuffer = json['OnlineBuffer'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Course': Course,
        'CourseTopic': CourseTopic,
        'Location': Location,
        'Has18Holes': Has18Holes,
        'OnlineBuffer': OnlineBuffer
    };

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

// @DataContract
class GetCoursesResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<CourseGeneric>? Courses;

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

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

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

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

/**
* GetCoursesRequires active-e Tee-Sheet Service
*/
// @DataContract
class GetCoursesRequest extends BaseRequest implements IConvertible
{
    GetCoursesRequest();
    GetCoursesRequest.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() => "GetCoursesRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'CourseGeneric': TypeInfo(TypeOf.Class, create:() => CourseGeneric()),
    'GetCoursesResponse': TypeInfo(TypeOf.Class, create:() => GetCoursesResponse()),
    'List<CourseGeneric>': TypeInfo(TypeOf.Class, create:() => <CourseGeneric>[]),
    'GetCoursesRequest': TypeInfo(TypeOf.Class, create:() => GetCoursesRequest()),
});

Dart GetCoursesRequest 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.

GET /api/GetCourses HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetCoursesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <Courses xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:CourseGeneric>
      <d2p1:Course>String</d2p1:Course>
      <d2p1:CourseTopic>String</d2p1:CourseTopic>
      <d2p1:Has18Holes>false</d2p1:Has18Holes>
      <d2p1:Location>String</d2p1:Location>
      <d2p1:OnlineBuffer>0</d2p1:OnlineBuffer>
    </d2p1:CourseGeneric>
  </Courses>
</GetCoursesResponse>