DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

import Foundation
import ServiceStack

public class GetRegistrationprofileFieldStates : Codable
{
    public var registrationprofileID:String?
    public var documentID:String?
    public var queueDocumentID:Int?
    public var standardDocumentID:String?
    public var requestTriggeredByDependentDocumentFieldIds:[String] = []
    public var currentRegistrationprofileFieldValues:[RegistrationProfileFieldValue] = []
    public var isOffice365Context:Bool?
    public var isOpenedFromNonDMSLocation:Bool?
    public var pidTag:String?

    required public init(){}
}

public class RegistrationProfileFieldValue : Codable
{
    public var documentFieldID:String?
    public var value:String?
    public var shadowValue:String?
    public var isModifiedByUser:Bool?

    required public init(){}
}

public class RegistrationProfileFieldStates : Codable
{
    public var readOnly:Bool?
    public var messages:InformationMessages?
    public var controlStates:[RegistrationProfileFieldStateBase] = []
    public var dependentFieldsControlStates:[RegistrationProfileFieldStateBase] = []

    required public init(){}
}

public class InformationMessages : List<InformationMessageBase>, IInformationMessages
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class InformationMessageBase : IInformationMessage, Codable
{
    public var type:MessageType?
    public var summary:String?
    public var fullMessage:String?
    public var fieldName:String?
    public var keepOpen:Bool?

    required public init(){}
}

public enum MessageType : Int, Codable
{
    case Information = 1
    case Warning = 2
    case Error = 3
    case Success = 4
}

public class RegistrationProfileFieldStateBase : Codable
{
    public var documentFieldID:String?
    public var required:Bool?
    public var visible:Bool?
    public var readonly:Bool?

    required public init(){}
}

Swift GetRegistrationprofileFieldStates DTOs

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>