tvpl.api

<back to all web services

GetAdvancedWorkflowInfoRequest

Requires Authentication
The following routes are available for this service:
GET/workflow/{WorkflowId}/advanced-info
GetAdvancedWorkflowInfoRequest Parameters:
NameParameterData TypeRequiredDescription
WorkflowIdpathintNo
AdvancedWorkflowInfoResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
DataformAdvancedWorkflowInfoDataYes
AdvancedWorkflowInfoData Parameters:
NameParameterData TypeRequiredDescription
ProviderformProviderNo
ContractformContractNo
EstimateformEstimateNo
PurchaseHistoryformList<PurchaseHistory>No
Provider Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringYes
TaxCodeformstringNo
AddressformstringNo
EmailformstringNo
PhoneformstringNo
AdditionalInfoformstringNo
ProviderTypeformintNo
CreatedAtformDateTime?No
CreatedByformint?No
Contract Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
WorkflowIdformintYes
ContractNoformstringNo
ContractDateformstringNo
ServiceNameformstringNo
ContractTypeformstringNo
ObjectiveformstringNo
LocationformstringNo
CreatedAtformDateTimeNo
CreatedByformintYes
Estimate Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
WorkflowIdformintYes
ValueBeforeTaxformint?No
TaxAmountformint?No
TotalAmountformint?No
CreatedAtformDateTimeNo
CreatedByformintYes
PurchaseHistory Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
WorkflowIdformintYes
SequenceNoformint?No
DetailformstringNo
UnitformstringNo
Quantityformint?No
UnitPriceformint?No
Amountformint?No
NoteformstringNo
CreatedAtformDateTimeNo
CreatedByformintYes

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.

GET /workflow/{WorkflowId}/advanced-info HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	{
		provider: 
		{
			id: 0,
			name: String,
			taxCode: String,
			address: String,
			email: String,
			phone: String,
			additionalInfo: String,
			providerType: 0,
			createdAt: "0001-01-01T00:00:00.0000000+07:06",
			createdBy: 0
		},
		contract: 
		{
			id: 0,
			workflowId: 0,
			contractNo: String,
			contractDate: String,
			serviceName: String,
			contractType: String,
			objective: String,
			location: String,
			createdBy: 0
		},
		estimate: 
		{
			id: 0,
			workflowId: 0,
			valueBeforeTax: 0,
			taxAmount: 0,
			totalAmount: 0,
			createdBy: 0
		},
		purchaseHistory: 
		[
			{
				id: 0,
				workflowId: 0,
				sequenceNo: 0,
				detail: String,
				unit: String,
				quantity: 0,
				unitPrice: 0,
				amount: 0,
				note: String,
				createdBy: 0
			}
		]
	}
}