DigiOffice Gateway Web Services

<back to all web services

AddDocumentQueuedForRegistration

Requires Authentication
AddDocumentQueuedForRegistration Parameters:
NameParameterData TypeRequiredDescription
RegistrationProfileIDqueryGuid?No
FileIDqueryGuid?No
DescriptionquerystringNo
NotequerystringNo
UploadOriginquerystringNo
DocumentIDqueryGuid?No
RootDocumentIDqueryGuid?No
AssignToUserIDqueryint?No
AssignToGroupIDqueryint?No
MetaDataqueryList<MetaDataField>No
MailingsqueryMailingsNo
AttachmentsMailingsqueryList<AttachmentMailing>No
MetaDataField Parameters:
NameParameterData TypeRequiredDescription
IDformGuid?No
DocumentVeldIDformGuid?No
NameformstringNo
LabelformstringNo
DatatypeformstringNo
PrintLabelformstringNo
EntityformstringNo
PrintValueformstringNo
RegistrationValueformstringNo
SPSiteColumnNameformstringNo
ShadowNameformstringNo
ShadowDatatypeformstringNo
ShadowSPSiteColumnNameformstringNo
ShadowSPSiteColumnRegistrationValueformstringNo
ShadowRegistrationValueformstringNo
IsKeyFieldformboolNo
KopierenBijNieuweVersieformboolNo
DocumentQueuedForRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentQueuedForRegistrationIDformintNo

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: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DMS.Operations.AddDocumentQueuedForRegistration, IDB.API",
	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: 
	{
		__type: "IDB.API.DMS.Mailings, IDB.API"
	},
	AttachmentsMailings: 
	[
		{
			__type: "IDB.API.DMS.AttachmentMailing, IDB.API"
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DMS.Operations.DocumentQueuedForRegistrationResponse, IDB.API",
	DocumentQueuedForRegistrationID: 0
}