Trendsic Platform Service

<back to all web services

ContactInvitationRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/ContactInvitation
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactInvitationResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactInvitation:
    id: int = 0
    agent_id: int = 0
    contact_id: int = 0
    url: Optional[str] = None
    url_code: Optional[str] = None
    i_decide_user_id: int = 0
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    created_by: Optional[str] = None
    deleted: bool = False
    date_deleted: datetime.datetime = datetime.datetime(1, 1, 1)
    deleted_by: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactInvitationRequest:
    contact_invitation: Optional[ContactInvitation] = None

Python ContactInvitationRequest 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 /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>