DigiOffice Gateway Web Services

<back to all web services

AddDocumentQueuedForRegistration

Requires Authentication 
import Foundation
import ServiceStack

public class AddDocumentQueuedForRegistration : Codable
{
    public var registrationProfileID:String?
    public var fileID:String?
    public var Description:String?
    public var note:String?
    public var uploadOrigin:String?
    public var documentID:String?
    public var rootDocumentID:String?
    public var assignToUserID:Int?
    public var assignToGroupID:Int?
    public var metaData:[MetaDataField] = []
    public var mailings:Mailings?
    public var attachmentsMailings:[AttachmentMailing] = []

    required public init(){}
}

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

    // @DataMember
    public var documentVeldID:String?

    // @DataMember
    public var name:String?

    // @DataMember
    public var label:String?

    // @DataMember
    public var datatype:String?

    // @DataMember
    public var printLabel:String?

    // @DataMember
    public var entity:String?

    // @DataMember
    public var printValue:String?

    // @DataMember
    public var registrationValue:String?

    // @DataMember
    public var spSiteColumnName:String?

    // @DataMember
    public var shadowName:String?

    // @DataMember
    public var shadowDatatype:String?

    // @DataMember
    public var shadowSPSiteColumnName:String?

    // @DataMember
    public var shadowSPSiteColumnRegistrationValue:String?

    // @DataMember
    public var shadowRegistrationValue:String?

    // @DataMember
    public var isKeyField:Bool?

    // @DataMember
    public var kopierenBijNieuweVersie:Bool?

    required public init(){}
}

public class Mailings : Codable
{
    required public init(){}
}

public class AttachmentMailing : Codable
{
    required public init(){}
}

public class DocumentQueuedForRegistrationResponse : Codable
{
    public var documentQueuedForRegistrationID:Int?

    required public init(){}
}

Swift AddDocumentQueuedForRegistration 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 /jsv/reply/AddDocumentQueuedForRegistration HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RegistrationProfileID: 00000000-0000-0000-0000-000000000000,
	FileID: 00000000-0000-0000-0000-000000000000,
	Description: String,
	Note: String,
	UploadOrigin: String,
	DocumentID: 00000000-0000-0000-0000-000000000000,
	RootDocumentID: 00000000-0000-0000-0000-000000000000,
	AssignToUserID: 0,
	AssignToGroupID: 0,
	MetaData: 
	[
		{
			ID: 00000000-0000-0000-0000-000000000000,
			DocumentVeldID: 00000000-0000-0000-0000-000000000000,
			Name: String,
			Label: String,
			Datatype: String,
			PrintLabel: String,
			Entity: String,
			PrintValue: String,
			RegistrationValue: String,
			SPSiteColumnName: String,
			ShadowName: String,
			ShadowDatatype: String,
			ShadowSPSiteColumnName: String,
			ShadowSPSiteColumnRegistrationValue: String,
			ShadowRegistrationValue: String,
			IsKeyField: False,
			KopierenBijNieuweVersie: False
		}
	],
	Mailings: {},
	AttachmentsMailings: 
	[
		{
			
		}
	]
}

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

{
	DocumentQueuedForRegistrationID: 0
}