tvpl.api

<back to all web services

GetDocumentNumberFormatRequest

Requires Authentication
The following routes are available for this service:
GET/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 GetDocumentNumberFormatRequest
{
    public id: number;

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

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

GET /document-number-format/{Id} HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentNumberFormat xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
  <CreatedAt>0001-01-01T00:00:00</CreatedAt>
  <CreatedBy>0</CreatedBy>
  <DeletedAt>0001-01-01T00:00:00</DeletedAt>
  <DeletedBy>0</DeletedBy>
  <FormatTemplate>String</FormatTemplate>
  <Id>0</Id>
  <IsActive>false</IsActive>
  <IsDeleted>false</IsDeleted>
  <LabelKeys>String</LabelKeys>
  <Name>String</Name>
  <Padding>0</Padding>
  <ResetPeriod>0</ResetPeriod>
  <TypeKey>String</TypeKey>
  <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  <UpdatedBy>0</UpdatedBy>
</DocumentNumberFormat>