BokaMera.API.Host

<back to all web services

SubscribedToNewsletter

The following routes are available for this service:
GET/newsletter/subscribeSubscribed to newsletter
import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class SubscribedToNewsletter implements ICompany, IConvertible
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    String? CompanyId;

    /**
    * The customer email.
    */
    // @ApiMember(Description="The customer email.", IsRequired=true)
    String? Email;

    SubscribedToNewsletter({this.CompanyId,this.Email});
    SubscribedToNewsletter.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

Dart SubscribedToNewsletter 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 /newsletter/subscribe HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfSubscribedUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <SubscribedUserResponse>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <Subscribed>false</Subscribed>
  </SubscribedUserResponse>
</ArrayOfSubscribedUserResponse>