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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"TemplateText":"String","InviteGuid":"00000000000000000000000000000000","PartnerAppUserId":0,"DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","Recipients":"String","Reference":"String","RetryCount":0,"StatusCodesId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TemplateText":"String","InviteGuid":"00000000000000000000000000000000","PartnerAppUserId":0,"DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","Recipients":"String","Reference":"String","RetryCount":0,"StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}