fkm

CommonDocumentsGet

The following routes are available for this service:
GET, POST	/CommonDocumentsGet

**CommonDocumentsGet** Parameters:
Name	Parameter	Data Type	Required	Description
DocumentGetListFull	body	DocumentGetListFull	No
MovementGetList	body	MovementGetList	No

**DocumentGetListFull** Parameters:
Name	Parameter	Data Type	Required
UserName	form	string	Yes
DocumentType	form	DocumentType?	No
UpdateDate	form	string	No
ExcludeDateFromRange	form	bool	No

**DocumentType** Enum:
failure
warrantyService
additionalWorks
maintenance

**MovementGetList** Parameters:
Name	Parameter	Data Type	Required
UserName	form	string	Yes
UpdateDate	form	string	No
ExcludeDateFromRange	form	bool	No

**CommonDocumentsGetResponce** Parameters:
Name	Parameter	Data Type	Required
DocumentGetListFullResponse	form	DocumentGetListFullResponse	No
MovementGetListResponse	form	MovementGetListResponse	No
ResponseStatus	form	ResponseStatus	No

**DocumentGetListFullResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Documents	form	List<DocumentGetListFullItem>	No
ResponseStatus	form	ResponseStatus	No

**DocumentGetListFullItem** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Hardwares	form	List<StoreObjectHardware>	No

**BaseDocument** Parameters:
Name	Parameter	Data Type	Required
Uid	form	string	No
UserName	form	string	No
UidParent	form	string	No
ObjectUid	form	string	No
ProjectUid	form	string	No
Number	form	string	No
CreateDateUtc	form	DateTime	No
Author	form	string	No
DocumentType	form	string	No
KindOfMaintenance	form	string	No
Comment	form	string	No
CommentSMS	form	string	No
MaintenancePlanName	form	string	No
MaintenanceDateUtc	form	DateTime	No
CompletionStatus	form	string	No
DocumentStatus	form	string	No
IsFault	form	bool	No
Files	form	List<string>	No
IsRead	form	bool	No
ReadDateUtc	form	DateTime	No
Client	form	string	No
LastUpdateDateUtc	form	DateTime	No
StoreObject	form	StoreObject	No
DocumentNote	form	string	No
FilesComment	form	string	No
SurveyComment	form	string	No
MainTask	form	bool	No
DeadlineDateUtc	form	DateTime	No

**StoreObject** Parameters:
Name	Parameter	Data Type	Required
ObjectNumber	form	string	No
Name	form	string	No
District	form	string	No
Client	form	string	No
Address	form	StoreObjectAddress	No
Contacts	form	List<StoreObjectContact>	No

**StoreObjectAddress** Parameters:
Name	Parameter	Data Type	Required
Address	form	string	No
Longitude	form	string	No
Latitude	form	string	No

**StoreObjectContact** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Phone	form	string	No
Position	form	string	No

**StoreObjectHardware** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Uid	form	string	No
ObjectUid	form	string	No
Number	form	string	No
CustomersHardwareName	form	string	No
CustomersHardwareType	form	string	No
Name	form	string	No
HardwareStatus	form	string	No
ReleaseDate	form	string	No
ExploitationStartDateUtc	form	DateTime?	No
SerialNumber	form	string	No
CustomersInventoryNumber	form	string	No
Comment	form	string	No
WarrantyUpToUtc	form	DateTime?	No

**MovementGetListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Documents	form	List<MovementDocument>	No
ResponseStatus	form	ResponseStatus	No

**MovementDocument** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Status	form	string	No
Sender	form	string	No
SenderName	form	string	No
Receiver	form	string	No
ReceiverName	form	string	No
CreateDateUtc	form	DateTime	No
LastUpdateDateUtc	form	DateTime	No
Items	form	List<DocumentItem>	No
Comment	form	string	No
ApplicationVersion	form	string	No

**DocumentItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Uid	form	string	No
Name	form	string	No
Quantity	form	double	No
Quality	form	DocumentItemQuality	No
Unit	form	DocumentItemUnit	No
Characteristic	form	DocumentItemCharacteristic	No
Series	form	DocumentItemSeries	No

**DocumentItemQuality** Parameters:
Name	Parameter	Data Type	Required	Description
Uid	form	string	No
Name	form	string	No

**DocumentItemUnit** Parameters:
Name	Parameter	Data Type	Required
Uid	form	string	No
Name	form	string	No
Coefficients	form	double	No

**DocumentItemCharacteristic** Parameters:
Name	Parameter	Data Type	Required	Description
Uid	form	string	No
Name	form	string	No

**DocumentItemSeries** Parameters:
Name	Parameter	Data Type	Required
Uid	form	string	No
Name	form	string	No
SerialNumber	form	string	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.

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
		}
	}
}