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 .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 /category/update HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateCategoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <ChildList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </ChildList>
  <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
  <IsParty xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsParty>
  <Name xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Name>
  <Type xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">Department</Type>
  <Id>0</Id>
  <IsDeleted>false</IsDeleted>
</UpdateCategoryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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