POST api/Document/ModifyDocument
Request Information
URI Parameters
None.
Body Parameters
DocumentData| Name | Description | Type | Additional information |
|---|---|---|---|
| apiClientID | string |
None. |
|
| DocumentID | string |
None. |
|
| DocumentName | string |
None. |
|
| Data | string |
None. |
|
| Attachments | DocumentAttachments |
None. |
Request Formats
application/xml, text/xml
Sample:
<DocumentData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<apiClientID>sample string 1</apiClientID>
<DocumentID>sample string 2</DocumentID>
<DocumentName>sample string 3</DocumentName>
<Data>sample string 4</Data>
<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>
</DocumentData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CreateResult| Name | Description | 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>