fkm

<back to all web services

MovementGetList

Requires Authentication
The following routes are available for this service:
POST, GET/MovementGetList
MovementGetList Parameters:
NameParameterData TypeRequiredDescription
UserNamebodystringYes
UpdateDatebodystringNo
ExcludeDateFromRangebodyboolNo
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 /MovementGetList HTTP/1.1 
Host: s10.tdfkm.ru 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

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