fkm

<back to all web services

CompletionDocumentPush

Requires Authentication
The following routes are available for this service:
POST/CompletionDocumentPush
CompletionDocumentPush Parameters:
NameParameterData TypeRequiredDescription
IdbodystringYes
UserNamebodystringYes
TaskIdbodystringYes
NumberbodystringYes
DatebodystringYes
UidParentbodystringYes
ObjectUidbodystringYes
ProjectUidbodystringNo
CommentbodystringNo
HardwaresbodyList<PushCompletionHardware>No
CompletionTypebodyCompletionTypesNo
ParentTypebodyDocumentTypeNo
KindOfMaintenancebodyMaintenanceKindsNo
ApplicationVersionbodystringNo
PushCompletionHardware Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
UidformstringNo
NameformstringNo
ItemsformList<PushDocumentItem>No
PushDocumentItem Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
UidformstringNo
NameformstringNo
QuantityformdoubleNo
QualityformPushDocumentItemQualityNo
UnitformPushDocumentItemUnitNo
CharacteristicformPushDocumentItemCharacteristicNo
SeriesformPushDocumentItemSeriesNo
PushDocumentItemQuality Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
NameformstringNo
PushDocumentItemUnit Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
NameformstringNo
CoefficientsformdoubleNo
PushDocumentItemCharacteristic Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
NameformstringNo
PushDocumentItemSeries Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
NameformstringNo
SerialNumberformstringNo
CompletionTypes Enum:
completion
maintenance
report
DocumentType Enum:
failure
warrantyService
additionalWorks
maintenance
MaintenanceKinds Enum:
texno
xolod
stroyka
vik

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.

POST /CompletionDocumentPush HTTP/1.1 
Host: s10.tdfkm.ru 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	userName: String,
	taskId: String,
	number: String,
	date: String,
	uidParent: String,
	objectUid: String,
	projectUid: String,
	comment: String,
	hardwares: 
	[
		{
			id: String,
			uid: String,
			name: String,
			items: 
			[
				{
					id: String,
					uid: String,
					name: String,
					quantity: 0,
					quality: 
					{
						uid: String,
						name: String
					},
					unit: 
					{
						uid: String,
						name: String,
						coefficients: 0
					},
					characteristic: 
					{
						uid: String,
						name: String
					},
					series: 
					{
						uid: String,
						name: String,
						serialNumber: String
					}
				}
			]
		}
	],
	completionType: completion,
	parentType: failure,
	kindOfMaintenance: texno,
	applicationVersion: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	isOk: False,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}