BokaMera.API.Host

SubscribeToNewsletter

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


export class SubscribedUserResponse
{
    public Subscribed: boolean;
    public CompanyId: string;

    public constructor(init?: Partial<SubscribedUserResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class SubscribeToNewsletter implements ICompany
{
    /** @description 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 CompanyId?: string;

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

    public constructor(init?: Partial<SubscribeToNewsletter>) { (Object as any).assign(this, init); }
}

TypeScript 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>