PUT | /newsletter/subscribe | Subscribed to newsletter |
---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SubscribedUserResponse() =
member val Subscribed:Boolean = new Boolean() with get,set
member val CompanyId:Guid = new Guid() with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<AllowNullLiteral>]
type SubscribeToNewsletter() =
///<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.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Companies for which user is subscribed.
///</summary>
[<ApiMember(Description="Companies for which user is subscribed.", IsRequired=true)>]
member val SubscribedCompanies:ResizeArray<SubscribedUserResponse> = new ResizeArray<SubscribedUserResponse>() with get,set
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: 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>