BokaMera.API.Host

<back to all web services

UpdateNewsItem

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/news/{Id}Update a news itemUpdate a news item to the company of the currently logged in user, only administrators are allowed to update news items.
import 'package:servicestack/servicestack.dart';

class NewsItemQueryResponse implements IConvertible
{
    /**
    * The news item id
    */
    // @ApiMember(Description="The news item id")
    int? Id;

    /**
    * Heading of the news item
    */
    // @ApiMember(Description="Heading of the news item")
    String? Heading;

    /**
    * Body of the news item
    */
    // @ApiMember(Description="Body of the news item")
    String? Body;

    /**
    * Url to a image associated with the news
    */
    // @ApiMember(Description="Url to a image associated with the news")
    Uri? ImageUrl;

    /**
    * The timestamp from which the newsitem should be visible from
    */
    // @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
    DateTime? From;

    /**
    * The timestamp to which the newsitem should be visible to
    */
    // @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
    DateTime? To;

    /**
    * The timestamp when news was created
    */
    // @ApiMember(Description="The timestamp when news was created", IsRequired=true)
    DateTime? Created;

    ResponseStatus? ResponseStatus;

    NewsItemQueryResponse({this.Id,this.Heading,this.Body,this.ImageUrl,this.From,this.To,this.Created,this.ResponseStatus});
    NewsItemQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Heading = json['Heading'];
        Body = json['Body'];
        ImageUrl = JsonConverters.fromJson(json['ImageUrl'],'Uri',context!);
        From = JsonConverters.fromJson(json['From'],'DateTime',context!);
        To = JsonConverters.fromJson(json['To'],'DateTime',context!);
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Heading': Heading,
        'Body': Body,
        'ImageUrl': JsonConverters.toJson(ImageUrl,'Uri',context!),
        'From': JsonConverters.toJson(From,'DateTime',context!),
        'To': JsonConverters.toJson(To,'DateTime',context!),
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "NewsItemQueryResponse";
    TypeContext? context = _ctx;
}

// @ValidateRequest(Validator="IsAuthenticated")
class UpdateNewsItem implements ICompany, IConvertible
{
    /**
    * 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.")
    String? CompanyId;

    /**
    * Id of the newsitem to update
    */
    // @ApiMember(Description="Id of the newsitem to update", IsRequired=true, ParameterType="path")
    int? Id;

    /**
    * The news item header, keep this short and concise
    */
    // @ApiMember(Description="The news item header, keep this short and concise", IsRequired=true)
    String? Heading;

    /**
    * The news body text
    */
    // @ApiMember(Description="The news body text", IsRequired=true)
    String? Body;

    /**
    * Valid url to a image associated with the news
    */
    // @ApiMember(Description="Valid url to a image associated with the news")
    Uri? ImageUrl;

    /**
    * The timestamp from which the newsitem should be visible from
    */
    // @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
    DateTime? From;

    /**
    * The timestamp to which the newsitem should be visible to
    */
    // @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
    DateTime? To;

    UpdateNewsItem({this.CompanyId,this.Id,this.Heading,this.Body,this.ImageUrl,this.From,this.To});
    UpdateNewsItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        Heading = json['Heading'];
        Body = json['Body'];
        ImageUrl = JsonConverters.fromJson(json['ImageUrl'],'Uri',context!);
        From = JsonConverters.fromJson(json['From'],'DateTime',context!);
        To = JsonConverters.fromJson(json['To'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Id': Id,
        'Heading': Heading,
        'Body': Body,
        'ImageUrl': JsonConverters.toJson(ImageUrl,'Uri',context!),
        'From': JsonConverters.toJson(From,'DateTime',context!),
        'To': JsonConverters.toJson(To,'DateTime',context!)
    };

    getTypeName() => "UpdateNewsItem";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'NewsItemQueryResponse': TypeInfo(TypeOf.Class, create:() => NewsItemQueryResponse()),
    'Uri': TypeInfo(TypeOf.Class, create:() => Uri()),
    'UpdateNewsItem': TypeInfo(TypeOf.Class, create:() => UpdateNewsItem()),
});

Dart UpdateNewsItem 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 /news/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateNewsItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Body>String</Body>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <From>0001-01-01T00:00:00</From>
  <Heading>String</Heading>
  <Id>0</Id>
  <ImageUrl i:nil="true" />
  <To>0001-01-01T00:00:00</To>
</UpdateNewsItem>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NewsItemQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Body>String</Body>
  <Created>0001-01-01T00:00:00</Created>
  <From>0001-01-01T00:00:00</From>
  <Heading>String</Heading>
  <Id>0</Id>
  <ImageUrl i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <To>0001-01-01T00:00:00</To>
</NewsItemQueryResponse>