tvpl.api

UpdateStepStatusRequest

The following routes are available for this service:
POST	/WorkflowStep/status


export class WorkflowStepResponse implements IResponseRequest
{
    public code: number;
    public message: string;
    public insertedId: number;

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

export enum CategoryStatusKeys
{
    WorkCreated = 'WorkCreated',
    WorkInProgress = 'WorkInProgress',
    WorkReturned = 'WorkReturned',
    WorkCompleted = 'WorkCompleted',
    WorkCancelled = 'WorkCancelled',
    WorkDone = 'WorkDone',
    StepNotStarted = 'StepNotStarted',
    StepInProgress = 'StepInProgress',
    StepDone = 'StepDone',
    StepCompleted = 'StepCompleted',
    StepSkipped = 'StepSkipped',
    StepReturned = 'StepReturned',
    NotSigned = 'NotSigned',
    SignatureReturned = 'SignatureReturned',
    SignaturePending = 'SignaturePending',
}

export class UpdateStepStatusRequest
{
    public stepId: number;
    public statusKey: CategoryStatusKeys;
    public comment?: string;

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

TypeScript UpdateStepStatusRequest DTOs

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

HTTP + XML

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

POST /WorkflowStep/status HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateStepStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Comment>String</Comment>
  <StatusKey>WorkCreated</StatusKey>
  <StepId>0</StepId>
</UpdateStepStatusRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <InsertedId>0</InsertedId>
  <Message>String</Message>
</WorkflowStepResponse>