tvpl.api

<back to all web services

UpdateDocumentNumberFormatRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
PUT/document-number-format/{Id}

export class DocumentNumberFormat
{
    public id: number;
    // @Required()
    // @StringLength(50)
    public typeKey: string;

    // @Required()
    // @StringLength(255)
    public name: string;

    // @Required()
    // @StringLength(255)
    public formatTemplate: string;

    public padding: number;
    public resetPeriod: number;
    // @StringLength(500)
    public labelKeys?: string;

    public isActive: boolean;
    public isDeleted?: boolean;
    public deletedAt?: string;
    public deletedBy?: number;
    public createdAt?: string;
    public createdBy?: number;
    public updatedAt?: string;
    public updatedBy?: number;

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

export class UpdateDocumentNumberFormatRequest
{
    public id: number;
    public typeKey: string;
    public name: string;
    public formatTemplate: string;
    public padding: number;
    public resetPeriod: number;
    public labelKeys?: string;
    public isActive: boolean;

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

TypeScript UpdateDocumentNumberFormatRequest 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.

PUT /document-number-format/{Id} HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	typeKey: String,
	name: String,
	formatTemplate: String,
	padding: 0,
	resetPeriod: 0,
	labelKeys: String,
	isActive: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	typeKey: String,
	name: String,
	formatTemplate: String,
	padding: 0,
	resetPeriod: 0,
	labelKeys: String,
	isActive: False,
	isDeleted: False,
	deletedAt: "0001-01-01T00:00:00.0000000+07:06",
	deletedBy: 0,
	createdAt: "0001-01-01T00:00:00.0000000+07:06",
	createdBy: 0,
	updatedAt: "0001-01-01T00:00:00.0000000+07:06",
	updatedBy: 0
}