BokaMera.API.Host

<back to all web services

UserAgreementQuery

Requires Authentication
The following routes are available for this service:
GET/users/agreementGets latest not agreed agreement with optional history
import 'package:servicestack/servicestack.dart';

class UserAgreementQueryResponse implements IConvertible
{
    String? UserId;
    String? AgreementId;
    DateTime? UserAgreementCreated;
    bool? AgreedToLatest;
    List<String>? Documents;
    dynamic? ResponseStatus;

    UserAgreementQueryResponse({this.UserId,this.AgreementId,this.UserAgreementCreated,this.AgreedToLatest,this.Documents,this.ResponseStatus});
    UserAgreementQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UserId = json['UserId'];
        AgreementId = json['AgreementId'];
        UserAgreementCreated = JsonConverters.fromJson(json['UserAgreementCreated'],'DateTime',context!);
        AgreedToLatest = json['AgreedToLatest'];
        Documents = JsonConverters.fromJson(json['Documents'],'List<String>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'dynamic',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UserId': UserId,
        'AgreementId': AgreementId,
        'UserAgreementCreated': JsonConverters.toJson(UserAgreementCreated,'DateTime',context!),
        'AgreedToLatest': AgreedToLatest,
        'Documents': JsonConverters.toJson(Documents,'List<String>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'dynamic',context!)
    };

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

// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class UserAgreementQuery implements IConvertible
{
    String? UserId;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'UserAgreementQueryResponse': TypeInfo(TypeOf.Class, create:() => UserAgreementQueryResponse()),
    'UserAgreementQuery': TypeInfo(TypeOf.Class, create:() => UserAgreementQuery()),
});

Dart UserAgreementQuery 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 /users/agreement HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAgreementQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AgreedToLatest>false</AgreedToLatest>
  <AgreementId>00000000-0000-0000-0000-000000000000</AgreementId>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Documents>
  <ResponseStatus />
  <UserAgreementCreated>0001-01-01T00:00:00</UserAgreementCreated>
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
</UserAgreementQueryResponse>