digitaluapi

<back to all web services

CurrencyRatesEdit

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

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

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

        // @DataMember(Order=4)
        /** @var int */
        public int $ToCurrenciesId=0,

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

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

        // @DataMember(Order=8)
        /** @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['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['FromCurrenciesId'])) $this->FromCurrenciesId = $o['FromCurrenciesId'];
        if (isset($o['ToCurrenciesId'])) $this->ToCurrenciesId = $o['ToCurrenciesId'];
        if (isset($o['ExchangeRate'])) $this->ExchangeRate = $o['ExchangeRate'];
        if (isset($o['EffectiveDate'])) $this->EffectiveDate = JsonConverters::from('DateTime', $o['EffectiveDate']);
        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->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->FromCurrenciesId)) $o['FromCurrenciesId'] = $this->FromCurrenciesId;
        if (isset($this->ToCurrenciesId)) $o['ToCurrenciesId'] = $this->ToCurrenciesId;
        if (isset($this->ExchangeRate)) $o['ExchangeRate'] = $this->ExchangeRate;
        if (isset($this->EffectiveDate)) $o['EffectiveDate'] = JsonConverters::to('DateTime', $this->EffectiveDate);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class CurrencyRatesEdit 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 $TenantsId=0,

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

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

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['FromCurrenciesId'])) $this->FromCurrenciesId = $o['FromCurrenciesId'];
        if (isset($o['ToCurrenciesId'])) $this->ToCurrenciesId = $o['ToCurrenciesId'];
        if (isset($o['ExchangeRate'])) $this->ExchangeRate = $o['ExchangeRate'];
        if (isset($o['EffectiveDate'])) $this->EffectiveDate = JsonConverters::from('DateTime', $o['EffectiveDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->FromCurrenciesId)) $o['FromCurrenciesId'] = $this->FromCurrenciesId;
        if (isset($this->ToCurrenciesId)) $o['ToCurrenciesId'] = $this->ToCurrenciesId;
        if (isset($this->ExchangeRate)) $o['ExchangeRate'] = $this->ExchangeRate;
        if (isset($this->EffectiveDate)) $o['EffectiveDate'] = JsonConverters::to('DateTime', $this->EffectiveDate);
        return empty($o) ? new class(){} : $o;
    }
}

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

<CurrencyRatesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <FromCurrenciesId>0</FromCurrenciesId>
  <ToCurrenciesId>0</ToCurrenciesId>
  <ExchangeRate>0</ExchangeRate>
  <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
</CurrencyRatesEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CurrencyRatesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
  <ExchangeRate>0</ExchangeRate>
  <FromCurrenciesId>0</FromCurrenciesId>
  <Id>0</Id>
  <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>
  <TenantsId>0</TenantsId>
  <ToCurrenciesId>0</ToCurrenciesId>
</CurrencyRatesEditResponse>