| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /news | Add a news item | Add a news item to the company of the currently logged in user, only administrators are allowed to add news items. |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class NewsItemQueryResponse implements JsonSerializable
{
public function __construct(
/** @description The news item id */
// @ApiMember(Description="The news item id")
/** @var int */
public int $Id=0,
/** @description Heading of the news item */
// @ApiMember(Description="Heading of the news item")
/** @var string|null */
public ?string $Heading=null,
/** @description Body of the news item */
// @ApiMember(Description="Body of the news item")
/** @var string|null */
public ?string $Body=null,
/** @description Url to a image associated with the news */
// @ApiMember(Description="Url to a image associated with the news")
/** @var string|null */
public ?string $ImageUrl=null,
/** @description The timestamp from which the newsitem should be visible from */
// @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
/** @var DateTime */
public DateTime $From=new DateTime(),
/** @description The timestamp to which the newsitem should be visible to */
// @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
/** @var DateTime */
public DateTime $To=new DateTime(),
/** @description The timestamp when news was created */
// @ApiMember(Description="The timestamp when news was created", IsRequired=true)
/** @var DateTime */
public DateTime $Created=new DateTime(),
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Heading'])) $this->Heading = $o['Heading'];
if (isset($o['Body'])) $this->Body = $o['Body'];
if (isset($o['ImageUrl'])) $this->ImageUrl = JsonConverters::from('string', $o['ImageUrl']);
if (isset($o['From'])) $this->From = JsonConverters::from('DateTime', $o['From']);
if (isset($o['To'])) $this->To = JsonConverters::from('DateTime', $o['To']);
if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Heading)) $o['Heading'] = $this->Heading;
if (isset($this->Body)) $o['Body'] = $this->Body;
if (isset($this->ImageUrl)) $o['ImageUrl'] = JsonConverters::to('string', $this->ImageUrl);
if (isset($this->From)) $o['From'] = JsonConverters::to('DateTime', $this->From);
if (isset($this->To)) $o['To'] = JsonConverters::to('DateTime', $this->To);
if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @ValidateRequest(Validator="IsAuthenticated")
class CreateNewsItem implements ICompany, JsonSerializable
{
public function __construct(
/** @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.")
/** @var string|null */
public ?string $CompanyId=null,
/** @description The news item header, keep this short and concise */
// @ApiMember(Description="The news item header, keep this short and concise", IsRequired=true)
/** @var string */
public string $Heading='',
/** @description The news body text */
// @ApiMember(Description="The news body text", IsRequired=true)
/** @var string */
public string $Body='',
/** @description Valid url to a image associated with the news */
// @ApiMember(Description="Valid url to a image associated with the news")
/** @var string|null */
public ?string $ImageUrl=null,
/** @description The timestamp from which the newsitem should be visible from */
// @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
/** @var DateTime */
public DateTime $From=new DateTime(),
/** @description The timestamp to which the newsitem should be visible to */
// @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
/** @var DateTime */
public DateTime $To=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Heading'])) $this->Heading = $o['Heading'];
if (isset($o['Body'])) $this->Body = $o['Body'];
if (isset($o['ImageUrl'])) $this->ImageUrl = JsonConverters::from('string', $o['ImageUrl']);
if (isset($o['From'])) $this->From = JsonConverters::from('DateTime', $o['From']);
if (isset($o['To'])) $this->To = JsonConverters::from('DateTime', $o['To']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Heading)) $o['Heading'] = $this->Heading;
if (isset($this->Body)) $o['Body'] = $this->Body;
if (isset($this->ImageUrl)) $o['ImageUrl'] = JsonConverters::to('string', $this->ImageUrl);
if (isset($this->From)) $o['From'] = JsonConverters::to('DateTime', $this->From);
if (isset($this->To)) $o['To'] = JsonConverters::to('DateTime', $this->To);
return empty($o) ? new class(){} : $o;
}
}
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.
POST /news HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateNewsItem 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>
<ImageUrl i:nil="true" />
<To>0001-01-01T00:00:00</To>
</CreateNewsItem>
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>