DigiOffice Gateway Web Services

<back to all web services

UpdateDocumentRegistration

Requires Authentication
import Foundation
import ServiceStack

public class UpdateDocumentRegistration : Codable
{
    public var documentID:String?
    public var values:[RegistrationValue] = []
    public var processes:[Process] = []
    public var generateOoxml:Bool?

    required public init(){}
}

public class RegistrationValue : Codable
{
    public var key:String?
    public var value:String?
    public var shadowValue:String?

    required public init(){}
}

public class Process : Codable
{
    public var id:Int?
    public var title:String?
    public var Description:String?
    public var note:String?
    public var coordinator:String?
    public var urgent:Bool?
    public var transitions:[Transition] = []

    required public init(){}
}

public class Transition : Codable
{
    public var id:String?
    public var reason:String?
    public var delayDate:Date?
    public var delayReason:String?
    public var userIDs:[Int] = []
    public var groupIDs:[Int] = []

    required public init(){}
}

public class RegisterDocumentResponse : Codable
{
    public var isSucces:Bool?
    public var documentId:String?
    public var errorMessages:[String] = []
    public var ooxml:String?
    /**
    * Is it a corporate identity document?
    */
    // @ApiMember(Description="Is it a corporate identity document?", IsRequired=true)
    public var isCorporateIdentity:Bool?

    public var documentVariables:[String:String] = [:]

    required public init(){}
}


Swift UpdateDocumentRegistration 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/UpdateDocumentRegistration HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","DelayReason":"String","UserIDs":[0],"GroupIDs":[0]}]}],"GenerateOoxml":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsSucces":false,"DocumentId":"00000000-0000-0000-0000-000000000000","ErrorMessages":["String"],"Ooxml":"String","IsCorporateIdentity":false,"DocumentVariables":null}