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
import Foundation
import ServiceStack

// @DataContract
public class ClientInvitesAdd : Codable
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var inviteGuid:String

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var dateCreated:Date

    // @DataMember(Order=4)
    public var dateSent:Date?

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public var recipients:String

    // @DataMember(Order=6)
    public var reference:String

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    public var retryCount:Int

    // @DataMember(Order=8)
    // @Validate(Validator="NotNull")
    public var statusCodesId:Int

    // @DataMember(Order=9)
    public var tempateText:String

    // @DataMember(Order=10)
    // @Validate(Validator="NotNull")
    public var tenantsId:Int

    // @DataMember(Order=11)
    // @Validate(Validator="NotNull")
    public var clientsUserAuthId:Int

    required public init(){}
}

public class ClientInvitesAddResponse : Codable
{
    // @DataMember(Order=2)
    public var inviteGuid:String

    // @DataMember(Order=3)
    public var dateCreated:Date

    // @DataMember(Order=4)
    public var dateSent:Date?

    // @DataMember(Order=5)
    public var recipients:String

    // @DataMember(Order=6)
    public var reference:String

    // @DataMember(Order=7)
    public var retryCount:Int

    // @DataMember(Order=8)
    public var statusCodesId:Int

    // @DataMember(Order=9)
    public var tempateText:String

    // @DataMember(Order=10)
    public var tenantsId:Int

    // @DataMember(Order=11)
    public var clientsUserAuthId:Int

    // @DataMember(Order=13)
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift 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"}}}