DigiOffice Gateway Web Services

GetDocumentViewDetails

The following routes are available for this service:
GET POST	/api/documentviews/{Key}

import Foundation
import ServiceStack

public class GetDocumentViewDetails : Codable
{
    public var key:String?
    public var includeExplorers:Bool?

    required public init(){}
}

public class DocumentView : MobileView
{
    // @DataMember
    public var translateKey:String?

    // @DataMember
    public var siteMapKey:String?

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

    private enum CodingKeys : String, CodingKey {
        case translateKey
        case siteMapKey
    }

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

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

// @DataContract
public class MobileView : Codable
{
    // @DataMember
    public var id:String?

    // @DataMember
    public var title:String?

    // @DataMember
    public var imageUrl:String?

    // @DataMember
    public var childrenCount:Int?

    // @DataMember
    public var order:Int?

    // @DataMember
    public var explorers:[Explorer] = []

    required public init(){}
}

public class Explorer : Codable
{
    public var id:String?
    public var title:String?
    public var order:Int?

    required public init(){}
}

Swift GetDocumentViewDetails DTOs

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

HTTP + JSV

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

POST /api/documentviews/{Key} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Key: String,
	IncludeExplorers: False
}

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

{
	TranslateKey: String,
	SiteMapKey: String,
	Title: String,
	ImageUrl: String,
	ChildrenCount: 0,
	Order: 0,
	Explorers: 
	[
		{
			Title: String,
			Order: 0
		}
	]
}