| Requires any of the roles: | Worker, Agent, Administrator |
| POST,OPTIONS | /v1/ContactInvitation |
|---|
<?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 ContactInvitationResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class ContactInvitation implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var int */
public int $AgentId=0,
/** @var int */
public int $ContactId=0,
/** @var string|null */
public ?string $Url=null,
/** @var string|null */
public ?string $UrlCode=null,
/** @var int */
public int $iDecideUserId=0,
/** @var DateTime */
public DateTime $DateCreated=new DateTime(),
/** @var string */
public string $CreatedBy='',
/** @var bool|null */
public ?bool $Deleted=null,
/** @var DateTime */
public DateTime $DateDeleted=new DateTime(),
/** @var string */
public string $DeletedBy=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
if (isset($o['Url'])) $this->Url = $o['Url'];
if (isset($o['UrlCode'])) $this->UrlCode = $o['UrlCode'];
if (isset($o['iDecideUserId'])) $this->iDecideUserId = $o['iDecideUserId'];
if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
if (isset($o['Deleted'])) $this->Deleted = $o['Deleted'];
if (isset($o['DateDeleted'])) $this->DateDeleted = JsonConverters::from('DateTime', $o['DateDeleted']);
if (isset($o['DeletedBy'])) $this->DeletedBy = $o['DeletedBy'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
if (isset($this->Url)) $o['Url'] = $this->Url;
if (isset($this->UrlCode)) $o['UrlCode'] = $this->UrlCode;
if (isset($this->iDecideUserId)) $o['iDecideUserId'] = $this->iDecideUserId;
if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
if (isset($this->Deleted)) $o['Deleted'] = $this->Deleted;
if (isset($this->DateDeleted)) $o['DateDeleted'] = JsonConverters::to('DateTime', $this->DateDeleted);
if (isset($this->DeletedBy)) $o['DeletedBy'] = $this->DeletedBy;
return empty($o) ? new class(){} : $o;
}
}
class ContactInvitationRequest implements JsonSerializable
{
public function __construct(
/** @var ContactInvitation|null */
public ?ContactInvitation $ContactInvitation=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ContactInvitation'])) $this->ContactInvitation = JsonConverters::from('ContactInvitation', $o['ContactInvitation']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ContactInvitation)) $o['ContactInvitation'] = JsonConverters::to('ContactInvitation', $this->ContactInvitation);
return empty($o) ? new class(){} : $o;
}
}
PHP ContactInvitationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/ContactInvitation HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ContactInvitationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ContactInvitation>
<AgentId>0</AgentId>
<ContactId>0</ContactId>
<CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateDeleted>0001-01-01T00:00:00</DateDeleted>
<Deleted>false</Deleted>
<DeletedBy>00000000-0000-0000-0000-000000000000</DeletedBy>
<Id>0</Id>
<Url>String</Url>
<UrlCode>String</UrlCode>
<iDecideUserId>0</iDecideUserId>
</ContactInvitation>
</ContactInvitationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ContactInvitationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
</ContactInvitationResponse>