Retrieve a saved CV, cover letter or document

Retrieves the metadata and content of a specific CV, cover letter or document.

URL:	https://api.trademe.co.nz/v1/mytrademe/SavedDocuments/{savedDocumentId}.{file_format}
HTTP Method:	GET
Requires Authentication?	Yes
Permission Required:	MyTradeMeRead: Read your membership & listing data.
Supported Formats:	XML, JSON
Rate Limited?	Yes

URL parameters

savedDocumentId

Integer (required)

The unique ID of the document.

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

Query String parameters

exclude_file_content	Boolean (optional)	If true, does not return the file content in the response (the base64 encoded file). Defaults to false.

Returns

Information about a single CV, cover letter or other type of document.

SavedDocumentId

Integer

The unique identifier of the document. Not required when uploading a document.

FileName

String or null

The file name of the document. When uploading a new document, this can be the full path or just the file name, with or without a file extension.

DocumentType

Enumeration

The type of document.

Cv	0	A CV document
CoverLetter	1	A cover letter
Other	2	Other documents
All	4	All saved documents

SavedDocumentData

String or null

The actual document data (base64 encoded).

UploadDate

DateTime

The date the document was uploaded

Example XML Response (switch to JSON)

<SavedDocument xmlns="http://api.trademe.co.nz/v1">
  <SavedDocumentId>123</SavedDocumentId>
  <FileName>ABC</FileName>
  <DocumentType>Cv</DocumentType>
  <SavedDocumentData>ABC</SavedDocumentData>
  <UploadDate>2018-01-01T00:00:00Z</UploadDate>
</SavedDocument>

Example JSON Response (switch to XML)

{
  "SavedDocumentId": 123,
  "FileName": "ABC",
  "DocumentType": 0,
  "SavedDocumentData": "ABC",
  "UploadDate": "\/Date(1514764800)\/"
}