fkm

<back to all web services

CommonDocumentsGet

Requires Authentication
The following routes are available for this service:
GET, POST/CommonDocumentsGet
CommonDocumentsGet Parameters:
NameParameterData TypeRequiredDescription
DocumentGetListFullbodyDocumentGetListFullNo
MovementGetListbodyMovementGetListNo
DocumentGetListFull Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringYes
DocumentTypeformDocumentType?No
UpdateDateformstringNo
ExcludeDateFromRangeformboolNo
DocumentType Enum:
failure
warrantyService
additionalWorks
maintenance
MovementGetList Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringYes
UpdateDateformstringNo
ExcludeDateFromRangeformboolNo
CommonDocumentsGetResponce Parameters:
NameParameterData TypeRequiredDescription
DocumentGetListFullResponseformDocumentGetListFullResponseNo
MovementGetListResponseformMovementGetListResponseNo
ResponseStatusformResponseStatusNo
DocumentGetListFullResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentsformList<DocumentGetListFullItem>No
ResponseStatusformResponseStatusNo
DocumentGetListFullItem Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
HardwaresformList<StoreObjectHardware>No
BaseDocument Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
UserNameformstringNo
UidParentformstringNo
ObjectUidformstringNo
ProjectUidformstringNo
NumberformstringNo
CreateDateUtcformDateTimeNo
AuthorformstringNo
DocumentTypeformstringNo
KindOfMaintenanceformstringNo
CommentformstringNo
CommentSMSformstringNo
MaintenancePlanNameformstringNo
MaintenanceDateUtcformDateTimeNo
CompletionStatusformstringNo
DocumentStatusformstringNo
IsFaultformboolNo
FilesformList<string>No
IsReadformboolNo
ReadDateUtcformDateTimeNo
ClientformstringNo
LastUpdateDateUtcformDateTimeNo
StoreObjectformStoreObjectNo
DocumentNoteformstringNo
FilesCommentformstringNo
SurveyCommentformstringNo
MainTaskformboolNo
DeadlineDateUtcformDateTimeNo
StoreObject Parameters:
NameParameterData TypeRequiredDescription
ObjectNumberformstringNo
NameformstringNo
DistrictformstringNo
ClientformstringNo
AddressformStoreObjectAddressNo
ContactsformList<StoreObjectContact>No
StoreObjectAddress Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
LongitudeformstringNo
LatitudeformstringNo
StoreObjectContact Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PhoneformstringNo
PositionformstringNo
StoreObjectHardware Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
UidformstringNo
ObjectUidformstringNo
NumberformstringNo
CustomersHardwareNameformstringNo
CustomersHardwareTypeformstringNo
NameformstringNo
HardwareStatusformstringNo
ReleaseDateformstringNo
ExploitationStartDateUtcformDateTime?No
SerialNumberformstringNo
CustomersInventoryNumberformstringNo
CommentformstringNo
WarrantyUpToUtcformDateTime?No
MovementGetListResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentsformList<MovementDocument>No
ResponseStatusformResponseStatusNo
MovementDocument Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
StatusformstringNo
SenderformstringNo
SenderNameformstringNo
ReceiverformstringNo
ReceiverNameformstringNo
CreateDateUtcformDateTimeNo
LastUpdateDateUtcformDateTimeNo
ItemsformList<DocumentItem>No
CommentformstringNo
ApplicationVersionformstringNo
DocumentItem Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
UidformstringNo
NameformstringNo
QuantityformdoubleNo
QualityformDocumentItemQualityNo
UnitformDocumentItemUnitNo
CharacteristicformDocumentItemCharacteristicNo
SeriesformDocumentItemSeriesNo
DocumentItemQuality Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
NameformstringNo
DocumentItemUnit Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
NameformstringNo
CoefficientsformdoubleNo
DocumentItemCharacteristic Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
NameformstringNo
DocumentItemSeries Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
NameformstringNo
SerialNumberformstringNo

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 /CommonDocumentsGet HTTP/1.1 
Host: s10.tdfkm.ru 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	documentGetListFull: 
	{
		userName: String,
		documentType: failure,
		updateDate: String,
		excludeDateFromRange: False
	},
	movementGetList: 
	{
		userName: String,
		updateDate: String,
		excludeDateFromRange: False
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	documentGetListFullResponse: 
	{
		documents: 
		[
			{
				id: String,
				hardwares: 
				[
					{
						id: String,
						uid: String,
						objectUid: String,
						number: String,
						customersHardwareName: String,
						customersHardwareType: String,
						name: String,
						hardwareStatus: String,
						releaseDate: String,
						exploitationStartDateUtc: 0001-01-01,
						serialNumber: String,
						customersInventoryNumber: String,
						comment: String,
						warrantyUpToUtc: 0001-01-01
					}
				],
				uid: String,
				userName: String,
				uidParent: String,
				objectUid: String,
				projectUid: String,
				number: String,
				createDateUtc: 0001-01-01,
				author: String,
				documentType: String,
				kindOfMaintenance: String,
				comment: String,
				commentSMS: String,
				maintenancePlanName: String,
				maintenanceDateUtc: 0001-01-01,
				completionStatus: String,
				documentStatus: String,
				isFault: False,
				files: 
				[
					String
				],
				isRead: False,
				readDateUtc: 0001-01-01,
				client: String,
				lastUpdateDateUtc: 0001-01-01,
				storeObject: 
				{
					objectNumber: String,
					name: String,
					district: String,
					client: String,
					address: 
					{
						address: String,
						longitude: String,
						latitude: String
					},
					contacts: 
					[
						{
							name: String,
							phone: String,
							position: String
						}
					]
				},
				documentNote: String,
				filesComment: String,
				surveyComment: String,
				mainTask: False,
				deadlineDateUtc: 0001-01-01
			}
		],
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		}
	},
	movementGetListResponse: 
	{
		documents: 
		[
			{
				id: String,
				status: String,
				sender: String,
				senderName: String,
				receiver: String,
				receiverName: String,
				createDateUtc: 0001-01-01,
				lastUpdateDateUtc: 0001-01-01,
				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
						}
					}
				],
				comment: String,
				applicationVersion: String
			}
		],
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		}
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}