sfgboxapi

LicensesAdd

The following routes are available for this service:
POST	/licenses

<?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 LicensesAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $appUserId=0,

        // @DataMember(Order=3)
        /** @var DateTime */
        public DateTime $fromDate=new DateTime(),

        // @DataMember(Order=4)
        /** @var DateTime */
        public DateTime $toDate=new DateTime(),

        // @DataMember(Order=5)
        /** @var float */
        public float $paidAmount=0.0,

        // @DataMember(Order=6)
        /** @var DateTime */
        public DateTime $paidDate=new DateTime(),

        // @DataMember(Order=8)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['appUserId'])) $this->appUserId = $o['appUserId'];
        if (isset($o['fromDate'])) $this->fromDate = JsonConverters::from('DateTime', $o['fromDate']);
        if (isset($o['toDate'])) $this->toDate = JsonConverters::from('DateTime', $o['toDate']);
        if (isset($o['paidAmount'])) $this->paidAmount = $o['paidAmount'];
        if (isset($o['paidDate'])) $this->paidDate = JsonConverters::from('DateTime', $o['paidDate']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->appUserId)) $o['appUserId'] = $this->appUserId;
        if (isset($this->fromDate)) $o['fromDate'] = JsonConverters::to('DateTime', $this->fromDate);
        if (isset($this->toDate)) $o['toDate'] = JsonConverters::to('DateTime', $this->toDate);
        if (isset($this->paidAmount)) $o['paidAmount'] = $this->paidAmount;
        if (isset($this->paidDate)) $o['paidDate'] = JsonConverters::to('DateTime', $this->paidDate);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class LicensesAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $appUserId=0,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var DateTime */
        public DateTime $fromDate=new DateTime(),

        // @DataMember(Order=4)
        // @Validate(Validator="NotNull")
        /** @var DateTime */
        public DateTime $toDate=new DateTime(),

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var float */
        public float $paidAmount=0.0,

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var DateTime */
        public DateTime $paidDate=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['appUserId'])) $this->appUserId = $o['appUserId'];
        if (isset($o['fromDate'])) $this->fromDate = JsonConverters::from('DateTime', $o['fromDate']);
        if (isset($o['toDate'])) $this->toDate = JsonConverters::from('DateTime', $o['toDate']);
        if (isset($o['paidAmount'])) $this->paidAmount = $o['paidAmount'];
        if (isset($o['paidDate'])) $this->paidDate = JsonConverters::from('DateTime', $o['paidDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->appUserId)) $o['appUserId'] = $this->appUserId;
        if (isset($this->fromDate)) $o['fromDate'] = JsonConverters::to('DateTime', $this->fromDate);
        if (isset($this->toDate)) $o['toDate'] = JsonConverters::to('DateTime', $this->toDate);
        if (isset($this->paidAmount)) $o['paidAmount'] = $this->paidAmount;
        if (isset($this->paidDate)) $o['paidDate'] = JsonConverters::to('DateTime', $this->paidDate);
        return empty($o) ? new class(){} : $o;
    }
}

PHP LicensesAdd 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.

POST /licenses HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LicensesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId>0</AppUserId>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <ToDate>0001-01-01T00:00:00</ToDate>
  <PaidAmount>0</PaidAmount>
  <PaidDate>0001-01-01T00:00:00</PaidDate>
</LicensesAdd>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LicensesAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId>0</AppUserId>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <PaidAmount>0</PaidAmount>
  <PaidDate>0001-01-01T00:00:00</PaidDate>
  <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>
  <ToDate>0001-01-01T00:00:00</ToDate>
</LicensesAddResponse>