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
"use strict";
export class ContactInvitationResponse {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ContactInvitation {
    /** @param {{Id?:number,AgentId?:number,ContactId?:number,Url?:string,UrlCode?:string,iDecideUserId?:number,DateCreated?:string,CreatedBy?:string,Deleted?:boolean,DateDeleted?:string,DeletedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    AgentId;
    /** @type {number} */
    ContactId;
    /** @type {string} */
    Url;
    /** @type {string} */
    UrlCode;
    /** @type {number} */
    iDecideUserId;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    CreatedBy;
    /** @type {boolean} */
    Deleted;
    /** @type {string} */
    DateDeleted;
    /** @type {string} */
    DeletedBy;
}
export class ContactInvitationRequest {
    /** @param {{ContactInvitation?:ContactInvitation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ContactInvitation} */
    ContactInvitation;
}

JavaScript 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>