fkm

<back to all web services

DocumentGetListFull

Requires Authentication
The following routes are available for this service:
POST/DocumentGetListFull
DocumentGetListFull Parameters:
NameParameterData TypeRequiredDescription
UserNamebodystringYes
DocumentTypebodyDocumentType?No
UpdateDatebodystringNo
ExcludeDateFromRangebodyboolNo
DocumentType Enum:
failure
warrantyService
additionalWorks
maintenance

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

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

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