BokaMera.API.Host

<back to all web services

SubscribeToNewsletter

The following routes are available for this service:
PUT/newsletter/subscribeSubscribed to newsletter
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class SubscribedUserResponse
            Public Overridable Property Subscribed As Boolean
            Public Overridable Property CompanyId As Guid
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class SubscribeToNewsletter
            Implements ICompany
            Public Sub New()
                SubscribedCompanies = New List(Of SubscribedUserResponse)
            End Sub

            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Companies for which user is subscribed.
            '''</Summary>
            <ApiMember(Description:="Companies for which user is subscribed.", IsRequired:=true)>
            Public Overridable Property SubscribedCompanies As List(Of SubscribedUserResponse)
        End Class
    End Namespace
End Namespace

VB.NET SubscribeToNewsletter DTOs

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

HTTP + CSV

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

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

[{"Subscribed":false}]