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}
UpdateDocumentNumberFormatRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
TypeKeybodystringYes
NamebodystringYes
FormatTemplatebodystringYes
PaddingbodyintNo
ResetPeriodbodyintNo
LabelKeysbodystringNo
IsActivebodyboolNo
DocumentNumberFormat Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeKeyformstringYes
NameformstringYes
FormatTemplateformstringYes
PaddingformintNo
ResetPeriodformintNo
LabelKeysformstringNo
IsActiveformboolNo
IsDeletedformbool?No
DeletedAtformDateTime?No
DeletedByformint?No
CreatedAtformDateTime?No
CreatedByformint?No
UpdatedAtformDateTime?No
UpdatedByformint?No

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
}