digitaluapi

PartnerInvitesAdd

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

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

<?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 PartnerInvitesAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $TemplateText=null,

        // @DataMember(Order=3)
        /** @var string */
        public string $InviteGuid='',

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

        // @DataMember(Order=5)
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),

        // @DataMember(Order=6)
        /** @var DateTime|null */
        public ?DateTime $DateSent=null,

        // @DataMember(Order=7)
        /** @var string|null */
        public ?string $Recipients=null,

        // @DataMember(Order=8)
        /** @var string|null */
        public ?string $Reference=null,

        // @DataMember(Order=9)
        /** @var int */
        public int $RetryCount=0,

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TemplateText'])) $this->TemplateText = $o['TemplateText'];
        if (isset($o['InviteGuid'])) $this->InviteGuid = $o['InviteGuid'];
        if (isset($o['PartnerAppUserId'])) $this->PartnerAppUserId = $o['PartnerAppUserId'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['DateSent'])) $this->DateSent = JsonConverters::from('DateTimeOffset', $o['DateSent']);
        if (isset($o['Recipients'])) $this->Recipients = $o['Recipients'];
        if (isset($o['Reference'])) $this->Reference = $o['Reference'];
        if (isset($o['RetryCount'])) $this->RetryCount = $o['RetryCount'];
        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->TemplateText)) $o['TemplateText'] = $this->TemplateText;
        if (isset($this->InviteGuid)) $o['InviteGuid'] = $this->InviteGuid;
        if (isset($this->PartnerAppUserId)) $o['PartnerAppUserId'] = $this->PartnerAppUserId;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->DateSent)) $o['DateSent'] = JsonConverters::to('DateTimeOffset', $this->DateSent);
        if (isset($this->Recipients)) $o['Recipients'] = $this->Recipients;
        if (isset($this->Reference)) $o['Reference'] = $this->Reference;
        if (isset($this->RetryCount)) $o['RetryCount'] = $this->RetryCount;
        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 PartnerInvitesAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $TemplateText=null,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $InviteGuid='',

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

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

        // @DataMember(Order=6)
        /** @var DateTime|null */
        public ?DateTime $DateSent=null,

        // @DataMember(Order=7)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $Recipients='',

        // @DataMember(Order=8)
        /** @var string|null */
        public ?string $Reference=null,

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TemplateText'])) $this->TemplateText = $o['TemplateText'];
        if (isset($o['InviteGuid'])) $this->InviteGuid = $o['InviteGuid'];
        if (isset($o['PartnerAppUserId'])) $this->PartnerAppUserId = $o['PartnerAppUserId'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['DateSent'])) $this->DateSent = JsonConverters::from('DateTimeOffset', $o['DateSent']);
        if (isset($o['Recipients'])) $this->Recipients = $o['Recipients'];
        if (isset($o['Reference'])) $this->Reference = $o['Reference'];
        if (isset($o['RetryCount'])) $this->RetryCount = $o['RetryCount'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TemplateText)) $o['TemplateText'] = $this->TemplateText;
        if (isset($this->InviteGuid)) $o['InviteGuid'] = $this->InviteGuid;
        if (isset($this->PartnerAppUserId)) $o['PartnerAppUserId'] = $this->PartnerAppUserId;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->DateSent)) $o['DateSent'] = JsonConverters::to('DateTimeOffset', $this->DateSent);
        if (isset($this->Recipients)) $o['Recipients'] = $this->Recipients;
        if (isset($this->Reference)) $o['Reference'] = $this->Reference;
        if (isset($this->RetryCount)) $o['RetryCount'] = $this->RetryCount;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP PartnerInvitesAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /partner_invites HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"TemplateText":"String","InviteGuid":"00000000000000000000000000000000","PartnerAppUserId":0,"DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","Recipients":"String","Reference":"String","RetryCount":0,"StatusCodesId":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TemplateText":"String","InviteGuid":"00000000000000000000000000000000","PartnerAppUserId":0,"DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","Recipients":"String","Reference":"String","RetryCount":0,"StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}