digitaluapi

<back to all web services

ClientInvitesEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/client_invites/{Id}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        <DataContract>
        Public Partial Class ClientInvitesEdit
            <DataMember(Order:=1)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Id As Integer

            <DataMember(Order:=2)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property InviteGuid As Guid

            <DataMember(Order:=3)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property DateCreated As DateTimeOffset

            <DataMember(Order:=4)>
            Public Overridable Property DateSent As DateTimeOffset?

            <DataMember(Order:=5)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Recipients As String

            <DataMember(Order:=6)>
            Public Overridable Property Reference As String

            <DataMember(Order:=7)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property RetryCount As Integer

            <DataMember(Order:=8)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property StatusCodesId As Long

            <DataMember(Order:=9)>
            Public Overridable Property TempateText As String

            <DataMember(Order:=10)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property TenantsId As Integer

            <DataMember(Order:=11)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property ClientsUserAuthId As Integer
        End Class

        Public Partial Class ClientInvitesEditResponse
            <DataMember(Order:=1)>
            Public Overridable Property Id As Integer

            <DataMember(Order:=2)>
            Public Overridable Property InviteGuid As Guid

            <DataMember(Order:=3)>
            Public Overridable Property DateCreated As DateTimeOffset

            <DataMember(Order:=4)>
            Public Overridable Property DateSent As DateTimeOffset?

            <DataMember(Order:=5)>
            Public Overridable Property Recipients As String

            <DataMember(Order:=6)>
            Public Overridable Property Reference As String

            <DataMember(Order:=7)>
            Public Overridable Property RetryCount As Integer

            <DataMember(Order:=8)>
            Public Overridable Property StatusCodesId As Long

            <DataMember(Order:=9)>
            Public Overridable Property TempateText As String

            <DataMember(Order:=10)>
            Public Overridable Property TenantsId As Integer

            <DataMember(Order:=11)>
            Public Overridable Property ClientsUserAuthId As Integer

            <DataMember(Order:=13)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET ClientInvitesEdit 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.

PUT /client_invites/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	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

{
	Id: 0,
	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
		}
	}
}