DigiOffice Gateway Web Services

<back to all web services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

Requires Authentication
The following routes are available for this service:
POST/api/documentuploads/registerdocuments
System.NotSupportedException: Unknown language 'mjs', Supported languages: csharp, typescript, dart, java, kotlin, python, swift, vbnet, fsharp
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(MetadataTypes metadataTypes, MetadataTypesConfig typesConfig, String lang, IRequest req, Action`1 configure)
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(List`1 metadataTypes, String lang, IRequest req, Action`1 configure)
   at ServiceStack.Metadata.BaseMetadataHandler.d__12.MoveNext()

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

{
	Documents: 
	[
		{
			Values: 
			[
				{
					Value: String,
					ShadowValue: String
				}
			],
			Processes: 
			[
				{
					ID: 0,
					Title: String,
					Description: String,
					Note: String,
					Coordinator: String,
					Urgent: False,
					Transitions: 
					[
						{
							Reason: String,
							DelayDate: 0001-01-01,
							DelayReason: String,
							UserIDs: 
							[
								0
							],
							GroupIDs: 
							[
								0
							]
						}
					]
				}
			],
			DocumentUploadId: String,
			DocumentId: 00000000-0000-0000-0000-000000000000,
			StandardDocumentID: 00000000-0000-0000-0000-000000000000,
			HasUnsavedChangesInDocument: False,
			IsOpenedFromNonDMSLocation: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	RegisteredDocumentUploads: 
	[
		{
			DocumentUploadID: 0,
			IsSuccess: False,
			Message: String
		}
	]
}