DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileDetailsWithMessageQueue

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

    [<AllowNullLiteral>]
    type Registrationprofile() = 
        member val ID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Hint:String = null with get,set
        member val Order:Int32 = new Int32() with get,set
        member val RegisterAutomatically:Boolean = new Boolean() with get,set
        member val RegisterInBackground:Boolean = new Boolean() with get,set
        member val ThumbnailUrl:String = null with get,set
        member val ProgCode:String = null with get,set
        member val VersionControlType:Int32 = new Int32() with get,set
        member val WOPlaceLogo:Int32 = new Int32() with get,set
        member val WOPrinterBins:String = null with get,set
        member val SelectAllFiles:Boolean = new Boolean() with get,set

    type RegistrationprofileStepLayout =
        | OneColumn_12 = 0
        | TwoColumn_6_6 = 1
        | TwoColumn_7_5 = 2
        | ThreeColumn_4_4_4 = 3

    [<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 RegistrationprofileField() = 
        member val ID:Guid = new Guid() with get,set
        member val DocumentFieldID:Guid = new Guid() with get,set
        member val Label:String = null with get,set
        member val UserControlType:String = null with get,set
        member val UserControlProperties:ResizeArray<SerializableKeyValuePair<String,Object>> = new ResizeArray<SerializableKeyValuePair<String,Object>>() with get,set
        member val Hint:String = null with get,set
        member val Order:Int32 = new Int32() with get,set
        member val HasDependableFields:Boolean = new Boolean() with get,set
        member val EntityName:String = null with get,set
        member val State:RegistrationProfileFieldStateBase = null with get,set

    [<AllowNullLiteral>]
    type RegistrationprofileGroup() = 
        member val ID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Label:String = null with get,set
        member val Order:Int32 = new Int32() with get,set
        member val ColumnIndex:Int32 = new Int32() with get,set
        member val Fields:ResizeArray<RegistrationprofileField> = new ResizeArray<RegistrationprofileField>() with get,set
        member val LabelLayoutType:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type RegistrationprofileStep() = 
        member val ID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Order:Int32 = new Int32() with get,set
        member val Layout:RegistrationprofileStepLayout = new RegistrationprofileStepLayout() with get,set
        member val Groups:ResizeArray<RegistrationprofileGroup> = new ResizeArray<RegistrationprofileGroup>() with get,set

    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 RegistrationprofileDetails() = 
        inherit Registrationprofile()
        member val Steps:ResizeArray<RegistrationprofileStep> = new ResizeArray<RegistrationprofileStep>() with get,set
        member val Messages:ResizeArray<InformationMessageBase> = new ResizeArray<InformationMessageBase>() with get,set
        member val ReadOnly:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type GetRegistrationprofileDetailsWithMessageQueue() = 
        member val ID:Guid = new Guid() with get,set
        member val MessageQueueId:Int32 = new Int32() with get,set
        member val IsOffice365Context:Boolean = new Boolean() with get,set

F# GetRegistrationprofileDetailsWithMessageQueue 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/GetRegistrationprofileDetailsWithMessageQueue HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ID":"00000000-0000-0000-0000-000000000000","MessageQueueId":0,"IsOffice365Context":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Steps":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Order":0,"Layout":"OneColumn_12","Groups":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Order":0,"ColumnIndex":0,"Fields":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentFieldID":"00000000-0000-0000-0000-000000000000","Label":"String","UserControlType":"String","UserControlProperties":[{}],"Hint":"String","Order":0,"HasDependableFields":false,"EntityName":"String","State":{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}}],"LabelLayoutType":0}]}],"Messages":[{}],"ReadOnly":false,"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Hint":"String","Order":0,"RegisterAutomatically":false,"RegisterInBackground":false,"ThumbnailUrl":"String","ProgCode":"String","VersionControlType":0,"WOPlaceLogo":0,"WOPrinterBins":"String","SelectAllFiles":false}