DigiOffice Gateway Web Services

<back to all web services

RegisterDocument

export class RegisterDocumentResponse
{
    public IsSucces: boolean;
    public DocumentId: string;
    public ErrorMessages: string[];
    public Ooxml: string;
    /** @description Is it a corporate identity document? */
    // @ApiMember(Description="Is it a corporate identity document?", IsRequired=true)
    public IsCorporateIdentity: boolean;

    public DocumentVariables: { [index: string]: string; };

    public constructor(init?: Partial<RegisterDocumentResponse>) { (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); }
}

TypeScript RegisterDocument DTOs

POST /jsv/reply/RegisterDocument HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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

{
	IsSucces: False,
	ErrorMessages: 
	[
		String
	],
	Ooxml: String,
	IsCorporateIdentity: False
}