DigiOffice Gateway Web Services

<back to all web services

GetProcessDetailsRegistrationForm

Requires Authentication
The following routes are available for this service:
POST/api/processes/registrationform
"use strict";
export class UserOrGroup {
    /** @param {{ID?:number,Title?:string,IsChecked?:boolean,Image?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Title;
    /** @type {boolean} */
    IsChecked;
    /** @type {string} */
    Image;
}
export class User extends UserOrGroup {
    /** @param {{Image?:string,ID?:number,Title?:string,IsChecked?:boolean,Image?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Image;
}
export class Group extends UserOrGroup {
    /** @param {{Image?:string,ID?:number,Title?:string,IsChecked?:boolean,Image?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Image;
}
export class WorkflowTaskDelay {
    /** @param {{DelayDate?:string,Reason?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    DelayDate;
    /** @type {string} */
    Reason;
}
export class WorkflowTaskReason {
    /** @param {{Reason?:string,Required?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Reason;
    /** @type {boolean} */
    Required;
}
export class WorkflowTaskAdhocTransition {
    /** @param {{ID?:string,Title?:string,AssignmentAllowed?:boolean,AssignmentRequired?:boolean,UserEnvironment?:number,Users?:User[],Groups?:Group[],Delay?:WorkflowTaskDelay,Reason?:WorkflowTaskReason,UsersOrGroups?:UserOrGroup[],Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Title;
    /** @type {boolean} */
    AssignmentAllowed;
    /** @type {boolean} */
    AssignmentRequired;
    /** @type {number} */
    UserEnvironment;
    /** @type {User[]} */
    Users;
    /** @type {Group[]} */
    Groups;
    /** @type {WorkflowTaskDelay} */
    Delay;
    /** @type {WorkflowTaskReason} */
    Reason;
    /** @type {UserOrGroup[]} */
    UsersOrGroups;
    /** @type {string} */
    Value;
}
export class AdhocTransitionDetails {
    /** @param {{AdhocTransitions?:WorkflowTaskAdhocTransition[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WorkflowTaskAdhocTransition[]} */
    AdhocTransitions;
}
export class WorkflowTaskActionComment {
    /** @param {{Comment?:string,Required?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Comment;
    /** @type {boolean} */
    Required;
}
export class SideStepDetails extends AdhocTransitionDetails {
    /** @param {{Coordinator?:User,Comment?:WorkflowTaskActionComment,Urgent?:boolean,AdhocTransitions?:WorkflowTaskAdhocTransition[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {User} */
    Coordinator;
    /** @type {WorkflowTaskActionComment} */
    Comment;
    /** @type {boolean} */
    Urgent;
}
export class ProcessDetails extends SideStepDetails {
    /** @param {{ShowCoordinatorField?:boolean,Coordinator?:User,Comment?:WorkflowTaskActionComment,Urgent?:boolean,AdhocTransitions?:WorkflowTaskAdhocTransition[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    ShowCoordinatorField;
}
export class RegistrationProfileFieldValue {
    /** @param {{DocumentFieldID?:string,Value?:string,ShadowValue?:string,IsModifiedByUser?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentFieldID;
    /** @type {string} */
    Value;
    /** @type {string} */
    ShadowValue;
    /** @type {boolean} */
    IsModifiedByUser;
}
export class GetProcessDetailsRegistrationForm {
    /** @param {{ProcessID?:number,RegistrationprofileID?:string,DocumentID?:string,CurrentRegistrationprofileFieldValues?:RegistrationProfileFieldValue[],IsOffice365Context?:boolean,PidTag?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProcessID;
    /** @type {string} */
    RegistrationprofileID;
    /** @type {?string} */
    DocumentID;
    /** @type {RegistrationProfileFieldValue[]} */
    CurrentRegistrationprofileFieldValues;
    /** @type {boolean} */
    IsOffice365Context;
    /** @type {string} */
    PidTag;
}

JavaScript GetProcessDetailsRegistrationForm DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/processes/registrationform HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ProcessID":0,"RegistrationprofileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","CurrentRegistrationprofileFieldValues":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}],"IsOffice365Context":false,"PidTag":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ShowCoordinatorField":false,"Coordinator":{"Image":"Icons/User","ID":0,"Title":"String","IsChecked":false},"Comment":{"Comment":"String","Required":false},"Urgent":false,"AdhocTransitions":[{"ID":"00000000-0000-0000-0000-000000000000","Title":"String","AssignmentAllowed":false,"AssignmentRequired":false,"UserEnvironment":0,"Users":[{"Image":"Icons/User","ID":0,"Title":"String","IsChecked":false}],"Groups":[{"Image":"Icons/Group","ID":0,"Title":"String","IsChecked":false}],"Delay":{"DelayDate":"0001-01-01T00:00:00.0000000","Reason":"String"},"Reason":{"Reason":"String","Required":false},"UsersOrGroups":[{"__type":"IDB.API.DTO.User, IDB.API.DTO","Image":"Icons/User","ID":0,"Title":"String","IsChecked":false},{"__type":"IDB.API.DTO.Group, IDB.API.DTO","Image":"Icons/Group","ID":0,"Title":"String","IsChecked":false}],"Value":"String\r\nString"}]}