BokaMera.API.Host

<back to all web services

SubscribeToNewsletter

The following routes are available for this service:
PUT/newsletter/subscribeSubscribed to newsletter
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public class SubscribeToNewsletter : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * Companies for which user is subscribed.
    */
    // @ApiMember(Description="Companies for which user is subscribed.", IsRequired=true)
    public var subscribedCompanies:[SubscribedUserResponse] = []

    required public init(){}
}

public class SubscribedUserResponse : Codable
{
    public var subscribed:Bool
    public var companyId:String

    required public init(){}
}


Swift SubscribeToNewsletter DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	SubscribedCompanies: 
	[
		{
			Subscribed: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Subscribed: False
	}
]