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] = []

    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 : FieldState
{
    public var documentFieldID:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case documentFieldID
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        documentFieldID = try container.decodeIfPresent(String.self, forKey: .documentFieldID)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if documentFieldID != nil { try container.encode(documentFieldID, forKey: .documentFieldID) }
    }
}

public class FieldState : Codable
{
    public var required:Bool
    public var visible:Bool
    public var readonly:Bool

    required public init(){}
}

Swift GetRegistrationprofileFieldStates DTOs

POST /jsv/reply/GetRegistrationprofileFieldStates HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DocumentID: 00000000-0000-0000-0000-000000000000,
	QueueDocumentID: 0,
	StandardDocumentID: 00000000-0000-0000-0000-000000000000,
	RequestTriggeredByDependentDocumentFieldIds: 
	[
		00000000-0000-0000-0000-000000000000
	],
	CurrentRegistrationprofileFieldValues: 
	[
		{
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	],
	IsOffice365Context: False,
	IsOpenedFromNonDMSLocation: False,
	PidTag: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ReadOnly: False,
	Messages: 
	[
		{
			
		}
	],
	ControlStates: 
	[
		{
			Required: False,
			Visible: False,
			Readonly: False
		}
	]
}