| 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 .xml suffix or ?format=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>