BokaMera.API.Host

SubscribeToNewsletter

The following routes are available for this service:
PUT	/newsletter/subscribe	Subscribed to newsletter

"use strict";
export class SubscribedUserResponse {
    /** @param {{Subscribed?:boolean,CompanyId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Subscribed;
    /** @type {string} */
    CompanyId;
}
export class SubscribeToNewsletter {
    /** @param {{CompanyId?:string,SubscribedCompanies?:SubscribedUserResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {SubscribedUserResponse[]}
     * @description Companies for which user is subscribed. */
    SubscribedCompanies;
}

JavaScript 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: api.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
	}
]