BokaMera.API.Host

<back to all web services

SubscribeToNewsletter

The following routes are available for this service:
PUT/newsletter/subscribeSubscribed to newsletter
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class SubscribeToNewsletter : ICompany
{
    /**
    * 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.")
    var CompanyId:UUID? = null

    /**
    * Companies for which user is subscribed.
    */
    @ApiMember(Description="Companies for which user is subscribed.", IsRequired=true)
    var SubscribedCompanies:ArrayList<SubscribedUserResponse> = ArrayList<SubscribedUserResponse>()
}

open class SubscribedUserResponse
{
    var Subscribed:Boolean? = null
    var CompanyId:UUID? = null
}

Kotlin 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}]