Bombshell Agency Platform Service

<back to all web services

TPADocumentRequest

The following routes are available for this service:
GET,PUT,DELETE,OPTIONS/v1/TPADocument/{DocumentUID}

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/TPADocumentRequest HTTP/1.1 
Host: api3.appreciationfinancial.com 
Content-Type: text/jsv
Content-Length: length

{
	TPADocument: 
	[
		{
			ID: 0,
			DocumentUID: 00000000000000000000000000000000,
			TPAID: 0,
			TPATypeID: 0,
			FileName: String,
			FilePath: String,
			FileSizeInKB: 0,
			CreatedDate: 0001-01-01,
			CreatedBy: String,
			TPAName: String,
			TPAType: String
		}
	],
	DocumentUID: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	Attachment: 
	[
		{
			AttachmentId: 00000000000000000000000000000000,
			TableName: String,
			FieldName: String,
			RecordId: 0,
			AttachmentName: String,
			MimeType: String,
			AttachmentData: AA==,
			FileSizeInKB: 0,
			CreatedDate: 0001-01-01,
			CreatedBy: String,
			NeedsOCR: False,
			OCRDate: 0001-01-01,
			IsSecurities: False
		}
	]
}