POST api/Document/AddDocument

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
apiClientID	string	None.
DocumentName	string	None.
Data	string	None.
DocumentTypeCode	string	None.
EntityType	string	None.
EntityCode	string	None.
RootFolder	string	None.
NewFile	boolean	None.
Attachments	DocumentAttachments	None.
metadata	DocumentMetadata	None.

Request Formats

application/xml, text/xml

Sample:

<Document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <apiClientID>sample string 1</apiClientID>
  <DocumentName>sample string 2</DocumentName>
  <Data>sample string 3</Data>
  <DocumentTypeCode>sample string 4</DocumentTypeCode>
  <EntityType>sample string 5</EntityType>
  <EntityCode>sample string 6</EntityCode>
  <RootFolder>sample string 7</RootFolder>
  <NewFile>true</NewFile>
  <Attachments>
    <Attachment>
      <AttachmentName>sample string 1</AttachmentName>
      <AttachmentData>sample string 2</AttachmentData>
    </Attachment>
    <Attachment>
      <AttachmentName>sample string 1</AttachmentName>
      <AttachmentData>sample string 2</AttachmentData>
    </Attachment>
  </Attachments>
  <metadata>
    <Application>sample string 1</Application>
    <Author>sample string 2</Author>
    <Comment>sample string 3</Comment>
    <Company>sample string 4</Company>
    <DocumentDescription>sample string 5</DocumentDescription>
    <DocumentPublishTime>sample string 6</DocumentPublishTime>
    <Keywords>sample string 7</Keywords>
    <Leader>sample string 8</Leader>
    <Subject>sample string 9</Subject>
    <Type>sample string 10</Type>
    <User>sample string 11</User>
    <BusinessYear>1</BusinessYear>
  </metadata>
</Document>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateResult

Name	Type	Additional information
Keys	Collection of EntityKeyField	None.
ResultCode	ExternalResultCode	None.
Errors	Collection of Error	None.

Response Formats

application/xml, text/xml

Sample:

<CreateResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Keys>
    <Key>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Key>
    <Key>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Key>
  </Keys>
  <ResultCode>None</ResultCode>
  <Errors>
    <Error>
      <Level>Warning</Level>
      <Message>sample string 1</Message>
    </Error>
    <Error>
      <Level>Warning</Level>
      <Message>sample string 1</Message>
    </Error>
  </Errors>
</CreateResult>