POST api/{siteCode}/Document/PutDocument

Provides an upload mechanism to allow storage of documents against the specified Job Number / Customer Account Number combination within the physical file system.

Request Information

URI Parameters

Name	Description	Type	Additional information
siteCode	The site code.	integer	Required

Body Parameters

The document upload.

DocumentUpload

Name	Type	Additional information
JobNumber	string	Required
DocumentTitle	string	None.
FileName	string	Required
CustAccNum	string	None.
DocumentContent	Collection of byte	None.
Comment	string	None.

Request Formats

application/json, text/json

Sample:

{
  "JobNumber": "HE123456",
  "DocumentTitle": "Document Title",
  "FileName": null,
  "CustAccNum": "ANDYSI",
  "DocumentContent": "",
  "Comment": "This could be information about the document content"
}

application/xml, text/xml

Sample:

<DocumentUpload xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DocumentTitle>Document Title</DocumentTitle>
  <CustAccNum>ANDYSI</CustAccNum>
  <DocumentContent />
  <Comment>This could be information about the document content</Comment>
  <JobNumber>HE123456</JobNumber>
</DocumentUpload>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.