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 .xml suffix or ?format=xml

HTTP + XML

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

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

<GetRegistrationprofileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile.Operations">
  <CurrentRegistrationprofileFieldValues xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationProfileFieldValue>
      <d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
      <d2p1:IsModifiedByUser>false</d2p1:IsModifiedByUser>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationProfileFieldValue>
  </CurrentRegistrationprofileFieldValues>
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <IsOffice365Context>false</IsOffice365Context>
  <IsOpenedFromNonDMSLocation>false</IsOpenedFromNonDMSLocation>
  <PidTag>String</PidTag>
  <QueueDocumentID>0</QueueDocumentID>
  <RegistrationprofileID>00000000-0000-0000-0000-000000000000</RegistrationprofileID>
  <RequestTriggeredByDependentDocumentFieldIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </RequestTriggeredByDependentDocumentFieldIds>
  <StandardDocumentID>00000000-0000-0000-0000-000000000000</StandardDocumentID>
</GetRegistrationprofileFieldStates>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationProfileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
  <ControlStates>
    <RegistrationProfileFieldStateBase>
      <DocumentFieldID>00000000-0000-0000-0000-000000000000</DocumentFieldID>
      <Readonly>false</Readonly>
      <Required>false</Required>
      <Visible>false</Visible>
    </RegistrationProfileFieldStateBase>
  </ControlStates>
  <DependentFieldsControlStates>
    <RegistrationProfileFieldStateBase>
      <DocumentFieldID>00000000-0000-0000-0000-000000000000</DocumentFieldID>
      <Readonly>false</Readonly>
      <Required>false</Required>
      <Visible>false</Visible>
    </RegistrationProfileFieldStateBase>
  </DependentFieldsControlStates>
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.Core.Diagnostics.Interfaces">
    <d2p1:InformationMessageBase i:nil="true" />
  </Messages>
  <ReadOnly>false</ReadOnly>
</RegistrationProfileFieldStates>