BokaMera.API.Host

<back to all web services

SubscribeToNewsletter

The following routes are available for this service:
PUT/newsletter/subscribeSubscribed to newsletter
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class SubscribedUserResponse
    {
        public virtual bool Subscribed { get; set; }
        public virtual Guid CompanyId { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    public partial class SubscribeToNewsletter
        : ICompany
    {
        public SubscribeToNewsletter()
        {
            SubscribedCompanies = new List<SubscribedUserResponse>{};
        }

        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Companies for which user is subscribed.
        ///</summary>
        [ApiMember(Description="Companies for which user is subscribed.", IsRequired=true)]
        public virtual List<SubscribedUserResponse> SubscribedCompanies { get; set; }
    }

}

C# SubscribeToNewsletter 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.

PUT /newsletter/subscribe HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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