Cochrane+ App API

<back to all web services

SubmitFeeling

Requires Authentication
The following routes are available for this service:
POST/feeling/submitfeeling
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
{
    String? description;
    String? heading;
    bool? wasSuccessful;
    dynamic? modelState;

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

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

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

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

class SubmitFeelingResponse extends ApiServiceResponse implements IConvertible
{
    bool? photoRatingNeeded;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'photoRatingNeeded': photoRatingNeeded
    });

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

class AttendanceEventType
{
    static const AttendanceEventType ClockOut = const AttendanceEventType._(0);
    static const AttendanceEventType ClockIn = const AttendanceEventType._(1);
    static const AttendanceEventType StartLunch = const AttendanceEventType._(2);
    static const AttendanceEventType EndLunch = const AttendanceEventType._(3);
    static const AttendanceEventType StartBreak = const AttendanceEventType._(4);
    static const AttendanceEventType EndBreak = const AttendanceEventType._(5);

    final int _value;
    const AttendanceEventType._(this._value);
    int get value => _value;
    static List<AttendanceEventType> get values => const [ClockOut,ClockIn,StartLunch,EndLunch,StartBreak,EndBreak];
}

class SubmitFeeling extends ApiServiceRequest implements IConvertible
{
    int? statusIndex;
    AttendanceEventType? eventType;

    SubmitFeeling({this.statusIndex,this.eventType});
    SubmitFeeling.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'statusIndex': statusIndex,
        'eventType': JsonConverters.toJson(eventType,'AttendanceEventType',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'cochraneplus_api_dev.happen.zone', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'SubmitFeelingResponse': TypeInfo(TypeOf.Class, create:() => SubmitFeelingResponse()),
    'AttendanceEventType': TypeInfo(TypeOf.Enum, enumValues:AttendanceEventType.values),
    'SubmitFeeling': TypeInfo(TypeOf.Class, create:() => SubmitFeeling()),
});

Dart SubmitFeeling 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 /feeling/submitfeeling HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SubmitFeeling xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <EventType>ClockOut</EventType>
  <StatusIndex>0</StatusIndex>
</SubmitFeeling>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SubmitFeelingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <PhotoRatingNeeded>false</PhotoRatingNeeded>
</SubmitFeelingResponse>