digitaluapi

<back to all web services

PartnerRegister

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/partnerregister
<?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 PartnerRegisterResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @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['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->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class PartnerRegister implements JsonSerializable
{
    public function __construct(
        // @Validate(Validator="Email")
        /** @var string|null */
        public ?string $EMail=null,

        // @Validate(Validator="[NotNull,NotEmpty]")
        /** @var string|null */
        public ?string $Name=null,

        // @Validate(Validator="NotNull")
        /** @var string */
        public string $Password='',

        /** @var string|null */
        public ?string $ConfirmPassword=null,
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $Company='',

        // @Validate(Validator="NotNull")
        /** @var int */
        public int $CurrencyId=0,

        /** @var string[]|null */
        public ?array $Roles=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['EMail'])) $this->EMail = $o['EMail'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Password'])) $this->Password = $o['Password'];
        if (isset($o['ConfirmPassword'])) $this->ConfirmPassword = $o['ConfirmPassword'];
        if (isset($o['Company'])) $this->Company = $o['Company'];
        if (isset($o['CurrencyId'])) $this->CurrencyId = $o['CurrencyId'];
        if (isset($o['Roles'])) $this->Roles = JsonConverters::fromArray('string', $o['Roles']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->EMail)) $o['EMail'] = $this->EMail;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Password)) $o['Password'] = $this->Password;
        if (isset($this->ConfirmPassword)) $o['ConfirmPassword'] = $this->ConfirmPassword;
        if (isset($this->Company)) $o['Company'] = $this->Company;
        if (isset($this->CurrencyId)) $o['CurrencyId'] = $this->CurrencyId;
        if (isset($this->Roles)) $o['Roles'] = JsonConverters::toArray('string', $this->Roles);
        return empty($o) ? new class(){} : $o;
    }
}

PHP PartnerRegister 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 /partnerregister HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PartnerRegister xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Company>String</Company>
  <ConfirmPassword>String</ConfirmPassword>
  <CurrencyId>0</CurrencyId>
  <EMail>String</EMail>
  <Name>String</Name>
  <Password>String</Password>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
</PartnerRegister>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PartnerRegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <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>
</PartnerRegisterResponse>