fkm

<back to all web services

CommonDocumentsGet

Requires Authentication
The following routes are available for this service:
GET, POST/CommonDocumentsGet
CommonDocumentsGet Parameters:
NameParameterData TypeRequiredDescription
DocumentGetListFullbodyDocumentGetListFullNo
MovementGetListbodyMovementGetListNo
DocumentGetListFull Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringYes
DocumentTypeformDocumentType?No
UpdateDateformstringNo
ExcludeDateFromRangeformboolNo
DocumentType Enum:
failure
warrantyService
additionalWorks
maintenance
MovementGetList Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringYes
UpdateDateformstringNo
ExcludeDateFromRangeformboolNo
CommonDocumentsGetResponce Parameters:
NameParameterData TypeRequiredDescription
DocumentGetListFullResponseformDocumentGetListFullResponseNo
MovementGetListResponseformMovementGetListResponseNo
ResponseStatusformResponseStatusNo
DocumentGetListFullResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentsformList<DocumentGetListFullItem>No
ResponseStatusformResponseStatusNo
DocumentGetListFullItem Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
HardwaresformList<StoreObjectHardware>No
BaseDocument Parameters:
NameParameterData TypeRequiredDescription
UidformstringNo
UserNameformstringNo
UidParentformstringNo
ObjectUidformstringNo
ProjectUidformstringNo
NumberformstringNo
CreateDateUtcformDateTimeNo
AuthorformstringNo
DocumentTypeformstringNo
KindOfMaintenanceformstringNo
CommentformstringNo
CommentSMSformstringNo
MaintenancePlanNameformstringNo
MaintenanceDateUtcformDateTimeNo
CompletionStatusformstringNo
DocumentStatusformstringNo
IsFaultformboolNo
FilesformList<string>No
IsReadformboolNo
ReadDateUtcformDateTimeNo
ClientformstringNo
LastUpdateDateUtcformDateTimeNo
StoreObjectformStoreObjectNo
DocumentNoteformstringNo
FilesCommentformstringNo
SurveyCommentformstringNo
MainTaskformboolNo
DeadlineDateUtcformDateTimeNo
StoreObject Parameters:
NameParameterData TypeRequiredDescription
ObjectNumberformstringNo
NameformstringNo
DistrictformstringNo
ClientformstringNo
AddressformStoreObjectAddressNo
ContactsformList<StoreObjectContact>No
StoreObjectAddress Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
LongitudeformstringNo
LatitudeformstringNo
StoreObjectContact Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PhoneformstringNo
PositionformstringNo
StoreObjectHardware Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
UidformstringNo
ObjectUidformstringNo
NumberformstringNo
CustomersHardwareNameformstringNo
CustomersHardwareTypeformstringNo
NameformstringNo
HardwareStatusformstringNo
ReleaseDateformstringNo
ExploitationStartDateUtcformDateTime?No
SerialNumberformstringNo
CustomersInventoryNumberformstringNo
CommentformstringNo
WarrantyUpToUtcformDateTime?No
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 .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 /CommonDocumentsGet HTTP/1.1 
Host: s10.tdfkm.ru 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CommonDocumentsGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fkm">
  <DocumentGetListFull>
    <DocumentType>failure</DocumentType>
    <ExcludeDateFromRange>false</ExcludeDateFromRange>
    <UpdateDate>String</UpdateDate>
    <UserName>String</UserName>
  </DocumentGetListFull>
  <MovementGetList>
    <ExcludeDateFromRange>false</ExcludeDateFromRange>
    <UpdateDate>String</UpdateDate>
    <UserName>String</UserName>
  </MovementGetList>
</CommonDocumentsGet>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommonDocumentsGetResponce xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fkm">
  <DocumentGetListFullResponse>
    <Documents>
      <DocumentGetListFull.DocumentGetListFullItem>
        <Author>String</Author>
        <Client>String</Client>
        <Comment>String</Comment>
        <CommentSMS>String</CommentSMS>
        <CompletionStatus>String</CompletionStatus>
        <CreateDateUtc>0001-01-01T00:00:00</CreateDateUtc>
        <DeadlineDateUtc>0001-01-01T00:00:00</DeadlineDateUtc>
        <DocumentNote>String</DocumentNote>
        <DocumentStatus>String</DocumentStatus>
        <DocumentType>String</DocumentType>
        <Files xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Files>
        <FilesComment>String</FilesComment>
        <IsFault>false</IsFault>
        <IsRead>false</IsRead>
        <KindOfMaintenance>String</KindOfMaintenance>
        <LastUpdateDateUtc>0001-01-01T00:00:00</LastUpdateDateUtc>
        <MainTask>false</MainTask>
        <MaintenanceDateUtc>0001-01-01T00:00:00</MaintenanceDateUtc>
        <MaintenancePlanName>String</MaintenancePlanName>
        <Number>String</Number>
        <ObjectUid>String</ObjectUid>
        <ProjectUid>String</ProjectUid>
        <ReadDateUtc>0001-01-01T00:00:00</ReadDateUtc>
        <StoreObject>
          <Address>
            <Address>String</Address>
            <Latitude>String</Latitude>
            <Longitude>String</Longitude>
          </Address>
          <Client>String</Client>
          <Contacts>
            <StoreObjectContact>
              <Name>String</Name>
              <Phone>String</Phone>
              <Position>String</Position>
            </StoreObjectContact>
          </Contacts>
          <District>String</District>
          <Name>String</Name>
          <ObjectNumber>String</ObjectNumber>
        </StoreObject>
        <SurveyComment>String</SurveyComment>
        <Uid>String</Uid>
        <UidParent>String</UidParent>
        <UserName>String</UserName>
        <Hardwares>
          <StoreObjectHardware>
            <Comment>String</Comment>
            <CustomersHardwareName>String</CustomersHardwareName>
            <CustomersHardwareType>String</CustomersHardwareType>
            <CustomersInventoryNumber>String</CustomersInventoryNumber>
            <ExploitationStartDateUtc>0001-01-01T00:00:00</ExploitationStartDateUtc>
            <HardwareStatus>String</HardwareStatus>
            <Id>String</Id>
            <Name>String</Name>
            <Number>String</Number>
            <ObjectUid>String</ObjectUid>
            <ReleaseDate>String</ReleaseDate>
            <SerialNumber>String</SerialNumber>
            <Uid>String</Uid>
            <WarrantyUpToUtc>0001-01-01T00:00:00</WarrantyUpToUtc>
          </StoreObjectHardware>
        </Hardwares>
        <Id>String</Id>
      </DocumentGetListFull.DocumentGetListFullItem>
    </Documents>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
  </DocumentGetListFullResponse>
  <MovementGetListResponse>
    <Documents>
      <MovementDocument>
        <ApplicationVersion>String</ApplicationVersion>
        <Comment>String</Comment>
        <CreateDateUtc>0001-01-01T00:00:00</CreateDateUtc>
        <Id>String</Id>
        <Items>
          <DocumentItem>
            <Characteristic>
              <Name>String</Name>
              <Uid>String</Uid>
            </Characteristic>
            <Id>String</Id>
            <Name>String</Name>
            <Quality>
              <Name>String</Name>
              <Uid>String</Uid>
            </Quality>
            <Quantity>0</Quantity>
            <Series>
              <Name>String</Name>
              <SerialNumber>String</SerialNumber>
              <Uid>String</Uid>
            </Series>
            <Uid>String</Uid>
            <Unit>
              <Coefficients>0</Coefficients>
              <Name>String</Name>
              <Uid>String</Uid>
            </Unit>
          </DocumentItem>
        </Items>
        <LastUpdateDateUtc>0001-01-01T00:00:00</LastUpdateDateUtc>
        <Receiver>String</Receiver>
        <ReceiverName>String</ReceiverName>
        <Sender>String</Sender>
        <SenderName>String</SenderName>
        <Status>String</Status>
      </MovementDocument>
    </Documents>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
  </MovementGetListResponse>
  <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>
</CommonDocumentsGetResponce>