POST v1/Documents/UploadDocumentJSON

Document Upload - File in Base64String

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Content	The file in Base64 string	string	Required
FileName	The name of the file	string	Required String length: inclusive between 0 and 254
ReferenceNumber	Number of entity that the document is in reference to (e.g. Policy or Quote Number, Agency Id). See: Reference Type	string	Required String length: inclusive between 0 and 30
PolicyTerm	The term number of the policy	integer	None.
ReferenceType	The type of the entity the document is in reference to	DocumentReferenceTypeEnum	Required
Category	Document category	DocumentCategoryCustomEnum	Required
Description	File description	string	String length: inclusive between 0 and 254
UserName	The user name of the user that uploaded the file	string	Required String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "Content": "sample string 1",
  "FileName": "sample string 2",
  "ReferenceNumber": "sample string 3",
  "PolicyTerm": 1,
  "ReferenceType": "Unknown",
  "Category": "AgentProfile",
  "Description": "sample string 4",
  "UserName": "sample string 5"
}

application/xml, text/xml

Sample:

<DocumentUploadData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound">
  <Category>AgentProfile</Category>
  <Content>sample string 1</Content>
  <Description>sample string 4</Description>
  <FileName>sample string 2</FileName>
  <PolicyTerm>1</PolicyTerm>
  <ReferenceNumber>sample string 3</ReferenceNumber>
  <ReferenceType>Unknown</ReferenceType>
  <UserName>sample string 5</UserName>
</DocumentUploadData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentDTO

Name	Description	Type	Additional information
FileName	Name of the document file	string	None.
Path	Name of the document file	string	None.
Description	Description of the document	string	None.
Category	Document category	DocumentCategoryCustomEnum	None.
SizeKB	File size of the document	decimal number	None.
CreationDate	Upload date of the document	date	None.
SystemType		SystemTypeEnum	None.
Id	Primary Id	integer	None.
WarningMessages	List of warning messages encountered while servicing request	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "FileName": "sample string 1",
  "Path": "sample string 2",
  "Description": "sample string 3",
  "Category": "AgentProfile",
  "SizeKB": 4.0,
  "CreationDate": "2024-04-27T06:21:35.0756622-10:00",
  "SystemType": "Unknown",
  "Id": 5
}

application/xml, text/xml

Sample:

<DocumentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>5</Id>
  <Category>AgentProfile</Category>
  <CreationDate>2024-04-27T06:21:35.0756622-10:00</CreationDate>
  <Description>sample string 3</Description>
  <FileName>sample string 1</FileName>
  <Path>sample string 2</Path>
  <SizeKB>4</SizeKB>
  <SystemType>Unknown</SystemType>
</DocumentDTO>