DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

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


open class GetRegistrationprofileFieldStates
{
    var RegistrationprofileID:UUID? = null
    var DocumentID:UUID? = null
    var QueueDocumentID:Int? = null
    var StandardDocumentID:UUID? = null
    var RequestTriggeredByDependentDocumentFieldIds:ArrayList<UUID> = ArrayList<UUID>()
    var CurrentRegistrationprofileFieldValues:ArrayList<RegistrationProfileFieldValue> = ArrayList<RegistrationProfileFieldValue>()
    var IsOffice365Context:Boolean? = null
    var IsOpenedFromNonDMSLocation:Boolean? = null
    var PidTag:String? = null
}

open class RegistrationProfileFieldValue
{
    var DocumentFieldID:UUID? = null
    var Value:String? = null
    var ShadowValue:String? = null
    var IsModifiedByUser:Boolean? = null
}

open class RegistrationProfileFieldStates
{
    var ReadOnly:Boolean? = null
    var Messages:InformationMessages? = null
    var ControlStates:ArrayList<RegistrationProfileFieldStateBase> = ArrayList<RegistrationProfileFieldStateBase>()
    var DependentFieldsControlStates:ArrayList<RegistrationProfileFieldStateBase> = ArrayList<RegistrationProfileFieldStateBase>()
}

open class InformationMessages : ArrayList<InformationMessageBase>(), IInformationMessages
{
}

open class InformationMessageBase : IInformationMessage
{
    var Type:MessageType? = null
    var Summary:String? = null
    var FullMessage:String? = null
    var FieldName:String? = null
    var KeepOpen:Boolean? = null
}

enum class MessageType(val value:Int)
{
    Information(1),
    Warning(2),
    Error(3),
    Success(4),
}

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

Kotlin GetRegistrationprofileFieldStates DTOs

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

HTTP + CSV

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

POST /csv/reply/GetRegistrationprofileFieldStates HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RegistrationprofileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","QueueDocumentID":0,"StandardDocumentID":"00000000-0000-0000-0000-000000000000","RequestTriggeredByDependentDocumentFieldIds":["00000000-0000-0000-0000-000000000000"],"CurrentRegistrationprofileFieldValues":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}],"IsOffice365Context":false,"IsOpenedFromNonDMSLocation":false,"PidTag":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ReadOnly":false,"Messages":[{}],"ControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}],"DependentFieldsControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}]}