Antel Merchandiser App API

<back to all web services

LogAttendanceEventRequest

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;
}

// @Flags()
class AttendanceType
{
    static const AttendanceType ClockedIn = const AttendanceType._(0);
    static const AttendanceType ClockedOut = const AttendanceType._(1);

    final int _value;
    const AttendanceType._(this._value);
    int get value => _value;
    static List<AttendanceType> get values => const [ClockedIn,ClockedOut];
}

class AttendanceResponse extends ApiServiceResponse implements IConvertible
{
    double? ClockedInSessionsForDay;
    AttendanceType? Type;
    String? TypeString;

    AttendanceResponse({this.ClockedInSessionsForDay,this.Type,this.TypeString});
    AttendanceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ClockedInSessionsForDay = JsonConverters.toDouble(json['ClockedInSessionsForDay']);
        Type = JsonConverters.fromJson(json['Type'],'AttendanceType',context!);
        TypeString = json['TypeString'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ClockedInSessionsForDay': ClockedInSessionsForDay,
        'Type': JsonConverters.toJson(Type,'AttendanceType',context!),
        'TypeString': TypeString
    });

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

class LogAttendanceEventRequest extends ApiServiceRequest implements IConvertible
{
    AttendanceType? Type;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'returnit_api_dev.happen.zone', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'AttendanceType': TypeInfo(TypeOf.Enum, enumValues:AttendanceType.values),
    'AttendanceResponse': TypeInfo(TypeOf.Class, create:() => AttendanceResponse()),
    'LogAttendanceEventRequest': TypeInfo(TypeOf.Class, create:() => LogAttendanceEventRequest()),
});

Dart LogAttendanceEventRequest DTOs

POST /attendance/log HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LogAttendanceEventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Longitude>
  <Type>ClockedIn</Type>
</LogAttendanceEventRequest>

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

<AttendanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">false</WasSuccessful>
  <ClockedInSessionsForDay>0</ClockedInSessionsForDay>
  <Type>ClockedIn</Type>
</AttendanceResponse>