DigiOffice Gateway Web Services

<back to all web services

AddDocumentQueuedForRegistration

Requires Authentication
"use strict";
export class DocumentQueuedForRegistrationResponse {
    /** @param {{DocumentQueuedForRegistrationID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DocumentQueuedForRegistrationID;
}
export class MetaDataField {
    /** @param {{ID?:string,DocumentVeldID?:string,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?:boolean,KopierenBijNieuweVersie?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    ID;
    /** @type {?string} */
    DocumentVeldID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Label;
    /** @type {string} */
    Datatype;
    /** @type {string} */
    PrintLabel;
    /** @type {string} */
    Entity;
    /** @type {string} */
    PrintValue;
    /** @type {string} */
    RegistrationValue;
    /** @type {string} */
    SPSiteColumnName;
    /** @type {string} */
    ShadowName;
    /** @type {string} */
    ShadowDatatype;
    /** @type {string} */
    ShadowSPSiteColumnName;
    /** @type {string} */
    ShadowSPSiteColumnRegistrationValue;
    /** @type {string} */
    ShadowRegistrationValue;
    /** @type {boolean} */
    IsKeyField;
    /** @type {boolean} */
    KopierenBijNieuweVersie;
}
export class Mailings {
    constructor(init) { Object.assign(this, init) }
}
export class AttachmentMailing {
    constructor(init) { Object.assign(this, init) }
}
export class AddDocumentQueuedForRegistration {
    /** @param {{RegistrationProfileID?:string,FileID?:string,Description?:string,Note?:string,UploadOrigin?:string,DocumentID?:string,RootDocumentID?:string,AssignToUserID?:number,AssignToGroupID?:number,MetaData?:MetaDataField[],Mailings?:Mailings,AttachmentsMailings?:AttachmentMailing[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    RegistrationProfileID;
    /** @type {?string} */
    FileID;
    /** @type {string} */
    Description;
    /** @type {string} */
    Note;
    /** @type {string} */
    UploadOrigin;
    /** @type {?string} */
    DocumentID;
    /** @type {?string} */
    RootDocumentID;
    /** @type {?number} */
    AssignToUserID;
    /** @type {?number} */
    AssignToGroupID;
    /** @type {MetaDataField[]} */
    MetaData;
    /** @type {Mailings} */
    Mailings;
    /** @type {AttachmentMailing[]} */
    AttachmentsMailings;
}

JavaScript 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: test-dogw.klokgroep.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
}