DigiOffice Gateway Web Services

<back to all web services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

export class RegisteredDocumentUpload
{
    public DocumentUploadID?: number;
    public IsSuccess?: boolean;
    public Message?: string;

    public constructor(init?: Partial<RegisteredDocumentUpload>) { (Object as any).assign(this, init); }
}

export class AddDocumentsForBackgroundRegistrationResponse
{
    public RegisteredDocumentUploads?: RegisteredDocumentUpload[];

    public constructor(init?: Partial<AddDocumentsForBackgroundRegistrationResponse>) { (Object as any).assign(this, init); }
}

export class RegistrationValue
{
    public Key?: string;
    public Value?: string;
    public ShadowValue?: string;

    public constructor(init?: Partial<RegistrationValue>) { (Object as any).assign(this, init); }
}

export class Transition
{
    public ID?: string;
    public Reason?: string;
    public DelayDate?: string;
    public DelayReason?: string;
    public UserIDs?: number[];
    public GroupIDs?: number[];

    public constructor(init?: Partial<Transition>) { (Object as any).assign(this, init); }
}

export class Process
{
    public ID?: number;
    public Title?: string;
    public Description?: string;
    public Note?: string;
    public Coordinator?: string;
    public Urgent?: boolean;
    public Transitions?: Transition[];

    public constructor(init?: Partial<Process>) { (Object as any).assign(this, init); }
}

export class RegisterDocument
{
    public RegistrationProfileID?: string;
    public Values?: RegistrationValue[];
    public Processes?: Process[];
    public DocumentUploadId?: string;
    public DocumentId?: string;
    public StandardDocumentID?: string;
    public HasUnsavedChangesInDocument?: boolean;
    public IsOpenedFromNonDMSLocation?: boolean;

    public constructor(init?: Partial<RegisterDocument>) { (Object as any).assign(this, init); }
}

/**
* Register documents queueud for registration in background
*/
// @Api(Description="Register documents queueud for registration in background")
// @ApiResponse(Description="All queued documents are linked to a systemtask for background processing", StatusCode=200)
export class AddDocumentsForBackgroundRegistration
{
    /**
    * List of queued documents to register in background
    */
    // @ApiMember(Description="List of queued documents to register in background", IsRequired=true)
    public Documents: RegisterDocument[];

    public constructor(init?: Partial<AddDocumentsForBackgroundRegistration>) { (Object as any).assign(this, init); }
}

TypeScript AddDocumentsForBackgroundRegistration DTOs

POST /api/documentuploads/registerdocuments HTTP/1.1 
Host: digiofficeapigateway.deltares.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
		}
	]
}