fkm

<back to all web services

DocumentPush

Requires Authentication
The following routes are available for this service:
POST/DocumentPush
DocumentPush Parameters:
NameParameterData TypeRequiredDescription
UidbodystringYes
UserNamebodystringYes
UidParentbodystringYes
ObjectUidbodystringYes
ProjectUidbodystringNo
NumberbodystringYes
CreateDatebodystringYes
AuthorbodystringNo
DocumentTypebodyDocumentType?Yes
KindOfMaintenancebodyMaintenanceKinds?Yes
CommentSMSbodystringNo
MaintenancePlanNamebodystringNo
ClientbodystringNo
StoreObjectbodyPushStoreObjectYes
DocumentNotebodystringNo
DocumentStatusbodyDocumentStatus?Yes
CompletionStatusbodyCompletionStatus?No
MaintenanceDatebodystringNo
MainTaskbodyboolNo
DeadlineDatebodystringNo
DocumentType Enum:
failure
warrantyService
additionalWorks
maintenance
MaintenanceKinds Enum:
texno
xolod
stroyka
vik
PushStoreObject Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
AddressformPushStoreObjectAddressNo
DistrictformstringNo
ClientformstringNo
ContactsformList<PushStoreObjectContact>No
ObjectNumberformstringNo
PushStoreObjectAddress Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
LongitudeformstringNo
LatitudeformstringNo
PushStoreObjectContact Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PhoneformstringNo
PositionformstringNo
DocumentStatus Enum:
active
closed
CompletionStatus Enum:
completed
needItems
completedButNotSendRemedi

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

{
	uid: String,
	userName: String,
	uidParent: String,
	objectUid: String,
	projectUid: String,
	number: String,
	createDate: String,
	author: String,
	documentType: failure,
	kindOfMaintenance: texno,
	commentSMS: String,
	maintenancePlanName: String,
	client: String,
	storeObject: 
	{
		name: String,
		address: 
		{
			address: String,
			longitude: String,
			latitude: String
		},
		district: String,
		client: String,
		contacts: 
		[
			{
				name: String,
				phone: String,
				position: String
			}
		],
		objectNumber: String
	},
	documentNote: String,
	documentStatus: active,
	completionStatus: completed,
	maintenanceDate: String,
	mainTask: False,
	deadlineDate: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	isOk: False,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}