tvpl.api

<back to all web services

UpdateCategoryRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/category/update

export enum CategoryTypes
{
    Department = 'Department',
    PartyGroup = 'PartyGroup',
    DocGroup = 'DocGroup',
    DocType = 'DocType',
    IssuingAgency = 'IssuingAgency',
    Status = 'Status',
    Subjects = 'Subjects',
    Workflow = 'Workflow',
}

export class CreateCategoryModel
{
    public name: string;
    public description: string;
    public type: CategoryTypes;
    public isParty: boolean;
    // @Ignore()
    public childList?: number[];

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

export class CreateCategoryResponse implements IResponseRequest
{
    public id: number;
    public code: number;
    public message: string;

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

export class UpdateCategoryRequest extends CreateCategoryModel
{
    public id: number;
    public isDeleted?: boolean;

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

TypeScript UpdateCategoryRequest DTOs

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

HTTP + JSV

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

POST /category/update HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	isDeleted: False,
	name: String,
	description: String,
	type: Department,
	isParty: False,
	childList: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	code: 0,
	message: String
}