POST api/JobDocument

File must be encoded in the JSON request. Only one file can be submitted per request.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DocumentId	Sedona internal autonumber for the Customer record	integer	None.
CompanyId	Value from Company table in the SedonaMaster; for security reasons, there is no lookup in the API for this value.	integer	Required
JobCode	value from OE_Job table	string	Required
SecurityLevel	If not set, defaults to 2. Possible values are: 1 - Everyone, 2 - Internal View Only, 3 - Management	integer	None.
FileName	Name of the file. If not specified, the file name will be set to the name of the file in the request (client's filename).	string	String length: inclusive between 0 and 255
DocumentType	Value from SY_Document_Type table in the SedonaDocument database; cannot be set to N/A, but any value not in the SY_Document_Type table will be added	string	Required String length: inclusive between 0 and 25
FileData	Set to a base64 encoding or leave blank if the file will be present in multipart MIME formatted request.	Collection of byte	None.
UploadDate	If not specified, set to the date and time of the upload.	date	None.
UserDescription		string	String length: inclusive between 0 and 50
UserCode	The user making this change; defaults to UserCode value from config file if not set explicitly	string	String length: inclusive between 0 and 25
Reference1		string	String length: inclusive between 0 and 50
Reference2		string	String length: inclusive between 0 and 50
Reference3		string	String length: inclusive between 0 and 50
Reference4		string	String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:

{
  "DocumentId": 1,
  "CompanyId": 2,
  "JobCode": "sample string 3",
  "SecurityLevel": 1,
  "FileName": "sample string 4",
  "DocumentType": "sample string 5",
  "FileData": "QEA=",
  "UploadDate": "2024-07-27T02:09:59.6351532-05:00",
  "UserDescription": "sample string 6",
  "UserCode": "sample string 7",
  "Reference1": "sample string 8",
  "Reference2": "sample string 9",
  "Reference3": "sample string 10",
  "Reference4": "sample string 11"
}

application/xml, text/xml

Sample:

<JobDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <CompanyId>2</CompanyId>
  <DocumentId>1</DocumentId>
  <DocumentType>sample string 5</DocumentType>
  <FileData>QEA=</FileData>
  <FileName>sample string 4</FileName>
  <JobCode>sample string 3</JobCode>
  <Reference1>sample string 8</Reference1>
  <Reference2>sample string 9</Reference2>
  <Reference3>sample string 10</Reference3>
  <Reference4>sample string 11</Reference4>
  <SecurityLevel>1</SecurityLevel>
  <UploadDate>2024-07-27T02:09:59.6351532-05:00</UploadDate>
  <UserCode>sample string 7</UserCode>
  <UserDescription>sample string 6</UserDescription>
</JobDocument>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'JobDocument'.

Response Information

Resource Description

Collection of JobDocument

Name	Description	Type	Additional information
DocumentId	Sedona internal autonumber for the Customer record	integer	None.
CompanyId	Value from Company table in the SedonaMaster; for security reasons, there is no lookup in the API for this value.	integer	Required
JobCode	value from OE_Job table	string	Required
SecurityLevel	If not set, defaults to 2. Possible values are: 1 - Everyone, 2 - Internal View Only, 3 - Management	integer	None.
FileName	Name of the file. If not specified, the file name will be set to the name of the file in the request (client's filename).	string	String length: inclusive between 0 and 255
DocumentType	Value from SY_Document_Type table in the SedonaDocument database; cannot be set to N/A, but any value not in the SY_Document_Type table will be added	string	Required String length: inclusive between 0 and 25
FileData	Set to a base64 encoding or leave blank if the file will be present in multipart MIME formatted request.	Collection of byte	None.
UploadDate	If not specified, set to the date and time of the upload.	date	None.
UserDescription		string	String length: inclusive between 0 and 50
UserCode	The user making this change; defaults to UserCode value from config file if not set explicitly	string	String length: inclusive between 0 and 25
Reference1		string	String length: inclusive between 0 and 50
Reference2		string	String length: inclusive between 0 and 50
Reference3		string	String length: inclusive between 0 and 50
Reference4		string	String length: inclusive between 0 and 50

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentId": 1,
    "CompanyId": 2,
    "JobCode": "sample string 3",
    "SecurityLevel": 1,
    "FileName": "sample string 4",
    "DocumentType": "sample string 5",
    "FileData": "QEA=",
    "UploadDate": "2024-07-27T02:09:59.6520518-05:00",
    "UserDescription": "sample string 6",
    "UserCode": "sample string 7",
    "Reference1": "sample string 8",
    "Reference2": "sample string 9",
    "Reference3": "sample string 10",
    "Reference4": "sample string 11"
  },
  {
    "DocumentId": 1,
    "CompanyId": 2,
    "JobCode": "sample string 3",
    "SecurityLevel": 1,
    "FileName": "sample string 4",
    "DocumentType": "sample string 5",
    "FileData": "QEA=",
    "UploadDate": "2024-07-27T02:09:59.6520518-05:00",
    "UserDescription": "sample string 6",
    "UserCode": "sample string 7",
    "Reference1": "sample string 8",
    "Reference2": "sample string 9",
    "Reference3": "sample string 10",
    "Reference4": "sample string 11"
  }
]

application/xml, text/xml

Sample:

<ArrayOfJobDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <JobDocument>
    <CompanyId>2</CompanyId>
    <DocumentId>1</DocumentId>
    <DocumentType>sample string 5</DocumentType>
    <FileData>QEA=</FileData>
    <FileName>sample string 4</FileName>
    <JobCode>sample string 3</JobCode>
    <Reference1>sample string 8</Reference1>
    <Reference2>sample string 9</Reference2>
    <Reference3>sample string 10</Reference3>
    <Reference4>sample string 11</Reference4>
    <SecurityLevel>1</SecurityLevel>
    <UploadDate>2024-07-27T02:09:59.6520518-05:00</UploadDate>
    <UserCode>sample string 7</UserCode>
    <UserDescription>sample string 6</UserDescription>
  </JobDocument>
  <JobDocument>
    <CompanyId>2</CompanyId>
    <DocumentId>1</DocumentId>
    <DocumentType>sample string 5</DocumentType>
    <FileData>QEA=</FileData>
    <FileName>sample string 4</FileName>
    <JobCode>sample string 3</JobCode>
    <Reference1>sample string 8</Reference1>
    <Reference2>sample string 9</Reference2>
    <Reference3>sample string 10</Reference3>
    <Reference4>sample string 11</Reference4>
    <SecurityLevel>1</SecurityLevel>
    <UploadDate>2024-07-27T02:09:59.6520518-05:00</UploadDate>
    <UserCode>sample string 7</UserCode>
    <UserDescription>sample string 6</UserDescription>
  </JobDocument>
</ArrayOfJobDocument>