DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

Requires Authentication
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

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/GetRegistrationprofileFieldStates HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

{"ReadOnly":false,"Messages":[{}],"ControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}]}