DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

Requires Authentication
namespace IDB.API.DTO.Registrationprofile

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type MessageType =
        | Information = 1
        | Warning = 2
        | Error = 3
        | Success = 4

    [<AllowNullLiteral>]
    type InformationMessageBase() = 
        member val Type:MessageType = new MessageType() with get,set
        member val Summary:String = null with get,set
        member val FullMessage:String = null with get,set
        member val FieldName:String = null with get,set
        member val KeepOpen:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type InformationMessages() = 
        inherit ResizeArray<InformationMessageBase>()

    [<AllowNullLiteral>]
    type RegistrationProfileFieldStateBase() = 
        member val DocumentFieldID:Guid = new Guid() with get,set
        member val Required:Boolean = new Boolean() with get,set
        member val Visible:Boolean = new Boolean() with get,set
        member val Readonly:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RegistrationProfileFieldStates() = 
        member val ReadOnly:Boolean = new Boolean() with get,set
        member val Messages:InformationMessages = null with get,set
        member val ControlStates:ResizeArray<RegistrationProfileFieldStateBase> = new ResizeArray<RegistrationProfileFieldStateBase>() with get,set
        member val DependentFieldsControlStates:ResizeArray<RegistrationProfileFieldStateBase> = new ResizeArray<RegistrationProfileFieldStateBase>() with get,set

    [<AllowNullLiteral>]
    type RegistrationProfileFieldValue() = 
        member val DocumentFieldID:Guid = new Guid() with get,set
        member val Value:String = null with get,set
        member val ShadowValue:String = null with get,set
        member val IsModifiedByUser:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type GetRegistrationprofileFieldStates() = 
        member val RegistrationprofileID:Guid = new Guid() with get,set
        member val DocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val QueueDocumentID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StandardDocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val RequestTriggeredByDependentDocumentFieldIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
        member val CurrentRegistrationprofileFieldValues:ResizeArray<RegistrationProfileFieldValue> = new ResizeArray<RegistrationProfileFieldValue>() with get,set
        member val IsOffice365Context:Boolean = new Boolean() with get,set
        member val IsOpenedFromNonDMSLocation:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val PidTag:String = null with get,set

F# 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}]}