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

export class PartnerInvitesAddResponse
{
    // @DataMember(Order=2)
    public TemplateText: string;

    // @DataMember(Order=3)
    public InviteGuid: string;

    // @DataMember(Order=4)
    public PartnerAppUserId: number;

    // @DataMember(Order=5)
    public DateCreated: string;

    // @DataMember(Order=6)
    public DateSent?: string;

    // @DataMember(Order=7)
    public Recipients: string;

    // @DataMember(Order=8)
    public Reference: string;

    // @DataMember(Order=9)
    public RetryCount: number;

    // @DataMember(Order=10)
    public StatusCodesId: number;

    // @DataMember(Order=12)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<PartnerInvitesAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PartnerInvitesAdd
{
    // @DataMember(Order=2)
    public TemplateText: string;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public InviteGuid: string;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public PartnerAppUserId: number;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public DateCreated: string;

    // @DataMember(Order=6)
    public DateSent?: string;

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    public Recipients: string;

    // @DataMember(Order=8)
    public Reference: string;

    // @DataMember(Order=9)
    // @Validate(Validator="NotNull")
    public RetryCount: number;

    // @DataMember(Order=10)
    // @Validate(Validator="NotNull")
    public StatusCodesId: number;

    public constructor(init?: Partial<PartnerInvitesAdd>) { (Object as any).assign(this, init); }
}

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