BokaMera.API.Host

<back to all web services

SubscribeToNewsletter

The following routes are available for this service:
PUT/newsletter/subscribeSubscribed to newsletter
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    public static class SubscribeToNewsletter implements ICompany
    {
        /**
        * 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.")
        public UUID CompanyId = null;

        /**
        * Companies for which user is subscribed.
        */
        @ApiMember(Description="Companies for which user is subscribed.", IsRequired=true)
        public ArrayList<SubscribedUserResponse> SubscribedCompanies = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public SubscribeToNewsletter setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public ArrayList<SubscribedUserResponse> getSubscribedCompanies() { return SubscribedCompanies; }
        public SubscribeToNewsletter setSubscribedCompanies(ArrayList<SubscribedUserResponse> value) { this.SubscribedCompanies = value; return this; }
    }

    public static class SubscribedUserResponse
    {
        public Boolean Subscribed = null;
        public UUID CompanyId = null;
        
        public Boolean isSubscribed() { return Subscribed; }
        public SubscribedUserResponse setSubscribed(Boolean value) { this.Subscribed = value; return this; }
        public UUID getCompanyId() { return CompanyId; }
        public SubscribedUserResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
    }

}

Java 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: testapi.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>