digitaluapi

<back to all web services

PartnerInvitesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/partner_invites
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class PartnerInvitesAdd
    {
        @DataMember(Order=2)
        public String TemplateText = null;

        @DataMember(Order=3)
        @Validate(Validator="NotNull")
        public UUID InviteGuid = null;

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public Integer PartnerAppUserId = null;

        @DataMember(Order=5)
        @Validate(Validator="NotNull")
        public Date DateCreated = null;

        @DataMember(Order=6)
        public Date DateSent = null;

        @DataMember(Order=7)
        @Validate(Validator="NotNull")
        public String Recipients = null;

        @DataMember(Order=8)
        public String Reference = null;

        @DataMember(Order=9)
        @Validate(Validator="NotNull")
        public Integer RetryCount = null;

        @DataMember(Order=10)
        @Validate(Validator="NotNull")
        public Long StatusCodesId = null;
        
        public String getTemplateText() { return TemplateText; }
        public PartnerInvitesAdd setTemplateText(String value) { this.TemplateText = value; return this; }
        public UUID getInviteGuid() { return InviteGuid; }
        public PartnerInvitesAdd setInviteGuid(UUID value) { this.InviteGuid = value; return this; }
        public Integer getPartnerAppUserId() { return PartnerAppUserId; }
        public PartnerInvitesAdd setPartnerAppUserId(Integer value) { this.PartnerAppUserId = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public PartnerInvitesAdd setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateSent() { return DateSent; }
        public PartnerInvitesAdd setDateSent(Date value) { this.DateSent = value; return this; }
        public String getRecipients() { return Recipients; }
        public PartnerInvitesAdd setRecipients(String value) { this.Recipients = value; return this; }
        public String getReference() { return Reference; }
        public PartnerInvitesAdd setReference(String value) { this.Reference = value; return this; }
        public Integer getRetryCount() { return RetryCount; }
        public PartnerInvitesAdd setRetryCount(Integer value) { this.RetryCount = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public PartnerInvitesAdd setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
    }

    public static class PartnerInvitesAddResponse
    {
        @DataMember(Order=2)
        public String TemplateText = null;

        @DataMember(Order=3)
        public UUID InviteGuid = null;

        @DataMember(Order=4)
        public Integer PartnerAppUserId = null;

        @DataMember(Order=5)
        public Date DateCreated = null;

        @DataMember(Order=6)
        public Date DateSent = null;

        @DataMember(Order=7)
        public String Recipients = null;

        @DataMember(Order=8)
        public String Reference = null;

        @DataMember(Order=9)
        public Integer RetryCount = null;

        @DataMember(Order=10)
        public Long StatusCodesId = null;

        @DataMember(Order=12)
        public ResponseStatus ResponseStatus = null;
        
        public String getTemplateText() { return TemplateText; }
        public PartnerInvitesAddResponse setTemplateText(String value) { this.TemplateText = value; return this; }
        public UUID getInviteGuid() { return InviteGuid; }
        public PartnerInvitesAddResponse setInviteGuid(UUID value) { this.InviteGuid = value; return this; }
        public Integer getPartnerAppUserId() { return PartnerAppUserId; }
        public PartnerInvitesAddResponse setPartnerAppUserId(Integer value) { this.PartnerAppUserId = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public PartnerInvitesAddResponse setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateSent() { return DateSent; }
        public PartnerInvitesAddResponse setDateSent(Date value) { this.DateSent = value; return this; }
        public String getRecipients() { return Recipients; }
        public PartnerInvitesAddResponse setRecipients(String value) { this.Recipients = value; return this; }
        public String getReference() { return Reference; }
        public PartnerInvitesAddResponse setReference(String value) { this.Reference = value; return this; }
        public Integer getRetryCount() { return RetryCount; }
        public PartnerInvitesAddResponse setRetryCount(Integer value) { this.RetryCount = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public PartnerInvitesAddResponse setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public PartnerInvitesAddResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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

<PartnerInvitesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <TemplateText>String</TemplateText>
  <InviteGuid>00000000-0000-0000-0000-000000000000</InviteGuid>
  <PartnerAppUserId>0</PartnerAppUserId>
  <DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateCreated>
  <DateSent xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateSent>
  <Recipients>String</Recipients>
  <Reference>String</Reference>
  <RetryCount>0</RetryCount>
  <StatusCodesId>0</StatusCodesId>
</PartnerInvitesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PartnerInvitesAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateCreated>
  <DateSent xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateSent>
  <InviteGuid>00000000-0000-0000-0000-000000000000</InviteGuid>
  <PartnerAppUserId>0</PartnerAppUserId>
  <Recipients>String</Recipients>
  <Reference>String</Reference>
  <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>
  <RetryCount>0</RetryCount>
  <StatusCodesId>0</StatusCodesId>
  <TemplateText>String</TemplateText>
</PartnerInvitesAddResponse>