digitaluapi

<back to all web services

PaymentPlansLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/payment_plans
<?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};


// @DataContract
class PaymentPlansLookup implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        /** @var int */
        public int $ActionsId=0,

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

        // @DataMember(Order=5)
        /** @var int */
        public int $MaxMonths=0,

        // @DataMember(Order=6)
        /** @var float */
        public float $DiscountAmount=0.0,

        // @DataMember(Order=7)
        /** @var int */
        public int $DiscountCurrenciesId=0,

        // @DataMember(Order=8)
        /** @var int */
        public int $StatusCodesId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['ActionsId'])) $this->ActionsId = $o['ActionsId'];
        if (isset($o['Date'])) $this->Date = JsonConverters::from('DateTime', $o['Date']);
        if (isset($o['MaxMonths'])) $this->MaxMonths = $o['MaxMonths'];
        if (isset($o['DiscountAmount'])) $this->DiscountAmount = $o['DiscountAmount'];
        if (isset($o['DiscountCurrenciesId'])) $this->DiscountCurrenciesId = $o['DiscountCurrenciesId'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->ActionsId)) $o['ActionsId'] = $this->ActionsId;
        if (isset($this->Date)) $o['Date'] = JsonConverters::to('DateTime', $this->Date);
        if (isset($this->MaxMonths)) $o['MaxMonths'] = $this->MaxMonths;
        if (isset($this->DiscountAmount)) $o['DiscountAmount'] = $this->DiscountAmount;
        if (isset($this->DiscountCurrenciesId)) $o['DiscountCurrenciesId'] = $this->DiscountCurrenciesId;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        return empty($o) ? new class(){} : $o;
    }
}

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

GET /payment_plans HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfPaymentPlansLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <PaymentPlansLookupResponse>
    <ActionsId>0</ActionsId>
    <Date>0001-01-01T00:00:00</Date>
    <DiscountAmount>0</DiscountAmount>
    <DiscountCurrenciesId>0</DiscountCurrenciesId>
    <MaxMonths>0</MaxMonths>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <StatusCodesId>0</StatusCodesId>
    <TenantsId>0</TenantsId>
  </PaymentPlansLookupResponse>
</ArrayOfPaymentPlansLookupResponse>