digitaluapi

<back to all web services

ClientInvitesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/client_invites
"use strict";
export class ClientInvitesAddResponse {
    /** @param {{InviteGuid?:string,DateCreated?:string,DateSent?:string,Recipients?:string,Reference?:string,RetryCount?:number,StatusCodesId?:number,TempateText?:string,TenantsId?:number,ClientsUserAuthId?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    InviteGuid;
    /** @type {string} */
    DateCreated;
    /** @type {?string} */
    DateSent;
    /** @type {string} */
    Recipients;
    /** @type {string} */
    Reference;
    /** @type {number} */
    RetryCount;
    /** @type {number} */
    StatusCodesId;
    /** @type {string} */
    TempateText;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    ClientsUserAuthId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ClientInvitesAdd {
    /** @param {{InviteGuid?:string,DateCreated?:string,DateSent?:string,Recipients?:string,Reference?:string,RetryCount?:number,StatusCodesId?:number,TempateText?:string,TenantsId?:number,ClientsUserAuthId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    InviteGuid;
    /** @type {string} */
    DateCreated;
    /** @type {?string} */
    DateSent;
    /** @type {string} */
    Recipients;
    /** @type {string} */
    Reference;
    /** @type {number} */
    RetryCount;
    /** @type {number} */
    StatusCodesId;
    /** @type {string} */
    TempateText;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    ClientsUserAuthId;
}

JavaScript ClientInvitesAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /client_invites HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"InviteGuid":"00000000000000000000000000000000","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,"TempateText":"String","TenantsId":0,"ClientsUserAuthId":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"InviteGuid":"00000000000000000000000000000000","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,"TempateText":"String","TenantsId":0,"ClientsUserAuthId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}