DigiOffice Gateway Web Services

<back to all web services

FinalizeCorporateIdentityMail

Requires Authentication
import java.math.*
import java.util.*
import net.servicestack.client.*


open class FinalizeCorporateIdentityMail : UpdateDraftCorporateIdentityMail()
{
    var ModifiedFieldValues:ArrayList<RegistrationValue>? = null
    var EmailMessageHash:String? = null
}

open class UpdateDraftCorporateIdentityMail : CreateDraftCorporateIdentityMail()
{
    var EmailHtml:String? = null
}

open class CreateDraftCorporateIdentityMail : Outlook365Properties()
{
    var RegistrationProfileID:UUID? = null
    var Values:ArrayList<RegistrationValue> = ArrayList<RegistrationValue>()
    var Processes:ArrayList<Process> = ArrayList<Process>()
    var DocumentUploadId:String? = null
    var MessageQueueId:String? = null
    var ReplyEmailHtml:String? = null
}

open class Outlook365Properties
{
    var PidTag:String? = null
    var ItemId:String? = null
    var EwsUrl:String? = null
    var Token:String? = null
}

open class RegistrationValue
{
    var Key:UUID? = null
    var Value:String? = null
    var ShadowValue:String? = null
}

open class Process
{
    var ID:Int? = null
    var Title:String? = null
    var Description:String? = null
    var Note:String? = null
    var Coordinator:String? = null
    var Urgent:Boolean? = null
    var Transitions:ArrayList<Transition> = ArrayList<Transition>()
}

open class Transition
{
    var ID:UUID? = null
    var Reason:String? = null
    var DelayDate:Date? = null
    var DelayReason:String? = null
    var UserIDs:ArrayList<Int> = ArrayList<Int>()
    var GroupIDs:ArrayList<Int> = ArrayList<Int>()
}

open class CorporateIdentityMail
{
    var DocumentId:UUID? = null
    var EmailHtml:String? = null
    var IsRegistered:Boolean? = null
    var DocumentNr:String? = null
    var Values:ArrayList<RegistrationProfileFieldStateBase> = ArrayList<RegistrationProfileFieldStateBase>()
    var RegistrationProfileID:UUID? = null
    var RegisterAutomatically:Boolean? = null
}

open class RegistrationProfileFieldStateBase
{
    var DocumentFieldID:UUID? = null
    var Required:Boolean? = null
    var Visible:Boolean? = null
    var Readonly:Boolean? = null
}

Kotlin FinalizeCorporateIdentityMail 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 /json/reply/FinalizeCorporateIdentityMail HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ModifiedFieldValues":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"EmailMessageHash":"String","EmailHtml":"String","RegistrationProfileID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","DelayReason":"String","UserIDs":[0],"GroupIDs":[0]}]}],"DocumentUploadId":"String","MessageQueueId":"String","ReplyEmailHtml":"String","PidTag":"String","ItemId":"String","EwsUrl":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DocumentId":"00000000-0000-0000-0000-000000000000","EmailHtml":"String","IsRegistered":false,"DocumentNr":"String","Values":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}],"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","RegisterAutomatically":false}