digitaluapi

<back to all web services

PaymentPlanDetailsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/payment_plan_details/{Id}
<?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 PaymentPlanDetailsEditResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        /** @var int */
        public int $PaymentPlansId=0,

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

        // @DataMember(Order=4)
        /** @var float */
        public float $PlannedAmount=0.0,

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

        // @DataMember(Order=6)
        /** @var int */
        public int $PaymentsId=0,

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

        // @DataMember(Order=9)
        /** @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['PaymentPlansId'])) $this->PaymentPlansId = $o['PaymentPlansId'];
        if (isset($o['PlannedDate'])) $this->PlannedDate = JsonConverters::from('DateTime', $o['PlannedDate']);
        if (isset($o['PlannedAmount'])) $this->PlannedAmount = $o['PlannedAmount'];
        if (isset($o['PlannedCurrenciesId'])) $this->PlannedCurrenciesId = $o['PlannedCurrenciesId'];
        if (isset($o['PaymentsId'])) $this->PaymentsId = $o['PaymentsId'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
        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->PaymentPlansId)) $o['PaymentPlansId'] = $this->PaymentPlansId;
        if (isset($this->PlannedDate)) $o['PlannedDate'] = JsonConverters::to('DateTime', $this->PlannedDate);
        if (isset($this->PlannedAmount)) $o['PlannedAmount'] = $this->PlannedAmount;
        if (isset($this->PlannedCurrenciesId)) $o['PlannedCurrenciesId'] = $this->PlannedCurrenciesId;
        if (isset($this->PaymentsId)) $o['PaymentsId'] = $this->PaymentsId;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $PaymentPlansId=0,

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

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

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $PlannedCurrenciesId=0,

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $PaymentsId=0,

        // @DataMember(Order=7)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $StatusCodesId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['PaymentPlansId'])) $this->PaymentPlansId = $o['PaymentPlansId'];
        if (isset($o['PlannedDate'])) $this->PlannedDate = JsonConverters::from('DateTime', $o['PlannedDate']);
        if (isset($o['PlannedAmount'])) $this->PlannedAmount = $o['PlannedAmount'];
        if (isset($o['PlannedCurrenciesId'])) $this->PlannedCurrenciesId = $o['PlannedCurrenciesId'];
        if (isset($o['PaymentsId'])) $this->PaymentsId = $o['PaymentsId'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->PaymentPlansId)) $o['PaymentPlansId'] = $this->PaymentPlansId;
        if (isset($this->PlannedDate)) $o['PlannedDate'] = JsonConverters::to('DateTime', $this->PlannedDate);
        if (isset($this->PlannedAmount)) $o['PlannedAmount'] = $this->PlannedAmount;
        if (isset($this->PlannedCurrenciesId)) $o['PlannedCurrenciesId'] = $this->PlannedCurrenciesId;
        if (isset($this->PaymentsId)) $o['PaymentsId'] = $this->PaymentsId;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP PaymentPlanDetailsEdit 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 /payment_plan_details/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaymentPlanDetailsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <PaymentPlansId>0</PaymentPlansId>
  <PlannedDate>0001-01-01T00:00:00</PlannedDate>
  <PlannedAmount>0</PlannedAmount>
  <PlannedCurrenciesId>0</PlannedCurrenciesId>
  <PaymentsId>0</PaymentsId>
  <StatusCodesId>0</StatusCodesId>
</PaymentPlanDetailsEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentPlanDetailsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <PaymentPlansId>0</PaymentPlansId>
  <PaymentsId>0</PaymentsId>
  <PlannedAmount>0</PlannedAmount>
  <PlannedCurrenciesId>0</PlannedCurrenciesId>
  <PlannedDate>0001-01-01T00:00:00</PlannedDate>
  <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>
  <StatusCodesId>0</StatusCodesId>
</PaymentPlanDetailsEditResponse>