POST v1/facilities/{facilityId}/savedocument
Saves the document.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| facilityId |
The facility identifier. |
globally unique identifier |
Required |
Body Parameters
The document.
SaveDocumentParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentBlob | Collection of byte |
None. |
|
| DocumentName | string |
None. |
|
| DocumentOrigin | string |
None. |
|
| DocumentType | string |
None. |
|
| UnitName | string |
None. |
|
| TenantFirstName | string |
None. |
|
| TenantLastName | string |
None. |
|
| TenantId | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"DocumentBlob": "QEA=",
"DocumentName": "sample string 1",
"DocumentOrigin": "sample string 2",
"DocumentType": "sample string 3",
"UnitName": "sample string 4",
"TenantFirstName": "sample string 5",
"TenantLastName": "sample string 6",
"TenantId": "sample string 7"
}
application/xml, text/xml
Sample:
<SaveDocumentParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models"> <DocumentBlob>QEA=</DocumentBlob> <DocumentName>sample string 1</DocumentName> <DocumentOrigin>sample string 2</DocumentOrigin> <DocumentType>sample string 3</DocumentType> <TenantFirstName>sample string 5</TenantFirstName> <TenantId>sample string 7</TenantId> <TenantLastName>sample string 6</TenantLastName> <UnitName>sample string 4</UnitName> </SaveDocumentParameters>
Response Information
Resource Description
SaveDocumentResult| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId | globally unique identifier |
None. |
|
| Errors | Collection of Exception |
None. |
|
| IsSuccess | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"DocumentId": "3bf679df-f950-42d7-b885-ee7f599e3ea5",
"Errors": [
{
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
},
{
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
}
],
"IsSuccess": true
}
application/xml, text/xml
Sample:
<SaveDocumentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models">
<Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
<d2p1:Exception>
<ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
<Message i:nil="true" xmlns="" />
<Data i:nil="true" xmlns="" />
<InnerException i:nil="true" xmlns="" />
<HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
<StackTraceString i:nil="true" xmlns="" />
<RemoteStackTraceString i:nil="true" xmlns="" />
<RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
<ExceptionMethod i:nil="true" xmlns="" />
<HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
<Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
<WatsonBuckets i:nil="true" xmlns="" />
</d2p1:Exception>
<d2p1:Exception>
<ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
<Message i:nil="true" xmlns="" />
<Data i:nil="true" xmlns="" />
<InnerException i:nil="true" xmlns="" />
<HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
<StackTraceString i:nil="true" xmlns="" />
<RemoteStackTraceString i:nil="true" xmlns="" />
<RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
<ExceptionMethod i:nil="true" xmlns="" />
<HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
<Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
<WatsonBuckets i:nil="true" xmlns="" />
</d2p1:Exception>
</Errors>
<IsSuccess xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">true</IsSuccess>
<DocumentId>3bf679df-f950-42d7-b885-ee7f599e3ea5</DocumentId>
</SaveDocumentResult>