DigiOffice Gateway Web Services

<back to all web services

GetProcessDetailsRegistrationForm

Requires Authentication
The following routes are available for this service:
POST/api/processes/registrationform

export class UserOrGroup
{
    public ID: number;
    public Title: string;
    public IsChecked: boolean;
    public Image: string;

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

export class User extends UserOrGroup
{
    public Image: string;

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

export class Group extends UserOrGroup
{
    public Image: string;

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

export class WorkflowTaskDelay
{
    public DelayDate?: string;
    public Reason: string;

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

export class WorkflowTaskReason
{
    public Reason: string;
    public Required: boolean;

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

export class WorkflowTaskAdhocTransition
{
    public ID: string;
    public Title: string;
    public AssignmentAllowed: boolean;
    public AssignmentRequired: boolean;
    public UserEnvironment: number;
    public Users: User[];
    public Groups: Group[];
    public Delay: WorkflowTaskDelay;
    public Reason: WorkflowTaskReason;
    public UsersOrGroups: UserOrGroup[];
    public Value: string;

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

export class AdhocTransitionDetails
{
    public AdhocTransitions: WorkflowTaskAdhocTransition[];

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

export class WorkflowTaskActionComment
{
    public Comment: string;
    public Required: boolean;

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

export class SideStepDetails extends AdhocTransitionDetails
{
    public Coordinator: User;
    public Comment: WorkflowTaskActionComment;
    public Urgent: boolean;

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

export class ProcessDetails extends SideStepDetails
{
    public ShowCoordinatorField: boolean;

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

export class RegistrationProfileFieldValue
{
    public DocumentFieldID: string;
    public Value: string;
    public ShadowValue: string;
    public IsModifiedByUser: boolean;

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

export class GetProcessDetailsRegistrationForm
{
    public ProcessID: number;
    public RegistrationprofileID: string;
    public DocumentID?: string;
    public CurrentRegistrationprofileFieldValues: RegistrationProfileFieldValue[];
    public IsOffice365Context: boolean;
    public PidTag: string;

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

TypeScript GetProcessDetailsRegistrationForm DTOs

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

HTTP + CSV

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: doapigw.baasbv.nl 
Accept: text/csv
Content-Type: text/csv
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/csv
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"}]}