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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DocumentPush xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fkm">
  <Author>String</Author>
  <Client>String</Client>
  <CommentSMS>String</CommentSMS>
  <CompletionStatus>completed</CompletionStatus>
  <CreateDate>String</CreateDate>
  <DeadlineDate>String</DeadlineDate>
  <DocumentNote>String</DocumentNote>
  <DocumentStatus>active</DocumentStatus>
  <DocumentType>failure</DocumentType>
  <KindOfMaintenance>texno</KindOfMaintenance>
  <MainTask>false</MainTask>
  <MaintenancePlanName>String</MaintenancePlanName>
  <Number>String</Number>
  <ObjectUid>String</ObjectUid>
  <ProjectUid>String</ProjectUid>
  <StoreObject>
    <Address>
      <Address>String</Address>
      <Latitude>String</Latitude>
      <Longitude>String</Longitude>
    </Address>
    <Client>String</Client>
    <Contacts>
      <DocumentPush.PushStoreObjectContact>
        <Name>String</Name>
        <Phone>String</Phone>
        <Position>String</Position>
      </DocumentPush.PushStoreObjectContact>
    </Contacts>
    <District>String</District>
    <Name>String</Name>
  </StoreObject>
  <Uid>String</Uid>
  <UidParent>String</UidParent>
  <UserName>String</UserName>
</DocumentPush>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentPush.DocumentPushResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fkm">
  <IsOk>false</IsOk>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</DocumentPush.DocumentPushResponse>