fkm

<back to all web services

ItemsAdd

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/ItemsAdd
ItemsAdd Parameters:
NameParameterData TypeRequiredDescription
ItemsListbodyList<PushItem>No
UpdateModebodyUpdateModeNo
PushItem Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringYes
UidformstringYes
ItemTypeformItemTypeYes
CodeformstringYes
NameformstringYes
QualityformPushItemQualityYes
UnitformPushItemUnitYes
AdditionalUnitsformList<PushItemUnit>No
StockformdoubleNo
CharacteristicformPushItemCharacteristicNo
SeriesformPushItemSeriesNo
ItemType Enum:
item
tool
uniform
PushItemQuality Parameters:
NameParameterData TypeRequiredDescription
UidformstringYes
CodeformstringNo
NameformstringYes
PushItemUnit Parameters:
NameParameterData TypeRequiredDescription
UidformstringYes
CodeformstringNo
NameformstringYes
CoefficientsformdoubleYesvalue >= 1
PushItemCharacteristic Parameters:
NameParameterData TypeRequiredDescription
UidformstringYes
CodeformstringNo
NameformstringYes
PushItemSeries Parameters:
NameParameterData TypeRequiredDescription
UidformstringYes
CodeformstringNo
NameformstringYes
ShelfLifeformstringNo
SerialNumberformstringNo
UpdateMode Enum:
PushItems
CleanAllBeforePush
CleanByUsersBeforePush

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

{
	itemsList: 
	[
		{
			userName: String,
			uid: String,
			itemType: item,
			code: String,
			name: String,
			quality: 
			{
				uid: String,
				code: String,
				name: String
			},
			unit: 
			{
				uid: String,
				code: String,
				name: String,
				coefficients: 0
			},
			additionalUnits: 
			[
				{
					uid: String,
					code: String,
					name: String,
					coefficients: 0
				}
			],
			stock: 0,
			characteristic: 
			{
				uid: String,
				code: String,
				name: String
			},
			series: 
			{
				uid: String,
				code: String,
				name: String,
				shelfLife: String,
				serialNumber: String
			}
		}
	],
	updateMode: PushItems
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	processedCount: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}