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

export class ClientInvitesAddResponse
{
    // @DataMember(Order=2)
    public InviteGuid: string;

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

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

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

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

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

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

    // @DataMember(Order=9)
    public TempateText: string;

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

    // @DataMember(Order=11)
    public ClientsUserAuthId: number;

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

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

// @DataContract
export class ClientInvitesAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public InviteGuid: string;

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

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

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

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

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

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

    // @DataMember(Order=9)
    public TempateText: string;

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

    // @DataMember(Order=11)
    // @Validate(Validator="NotNull")
    public ClientsUserAuthId: number;

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

TypeScript ClientInvitesAdd DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
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
		}
	}
}