GET api/Documents/Tagged

Retrieves a list of documents with the specified tag.

Request

Parameters

Name	Description	Default
`tag`	The tag to match.

Response

Body

Content Type: application/xml or application/json
Data set containing the documents, or an error message.

XML JSON
<Response> <Result> <!--Array of 'Item'--> <Item> <DocumentID>long</DocumentID> <!--Document number (unique ID)--> <DocumentDate>datetime</DocumentDate> <!--Document date (primary date)--> <FileID>long</FileID> <!--Unique file ID--> <ContactID>long</ContactID> <!--Contact number (primary contact)--> <DocumentName>string</DocumentName> <!--Document description--> <Attributes>int</Attributes> <!--Document attributes (flags)--> <Folder>string</Folder> <!--Folder path--> <DocumentExtension>string</DocumentExtension> <!--File extension--> <Pages>int</Pages> <!--Page count (if known)--> <DocumentType>string</DocumentType> <!--Name of document type--> <InReplyToID>long</InReplyToID> <!--In reply to document number--> <CreatedDate>datetime</CreatedDate> <!--Created/uploaded date--> <ModifiedDate>datetime</ModifiedDate> <!--Metadata last modified date--> <FileNumber>string</FileNumber> <!--Human-readable file number--> <Url>string</Url> <!--Location--> </Item> </Result> <Message>string</Message> <!--Error message--> </Response>
{ "Result": [{ "DocumentID": "long", // Document number (unique ID) "DocumentDate": "datetime", // Document date (primary date) "FileID": "long", // Unique file ID "ContactID": "long", // Contact number (primary contact) "DocumentName": "string", // Document description "Attributes": "int", // Document attributes (flags) "Folder": "string", // Folder path "DocumentExtension": "string", // File extension "Pages": "int", // Page count (if known) "DocumentType": "string", // Name of document type "InReplyToID": "long", // In reply to document number "CreatedDate": "datetime", // Created/uploaded date "ModifiedDate": "datetime", // Metadata last modified date "FileNumber": "string", // Human-readable file number "Url": "string" // Location }], "Message": "string" // Error message }

XML JSON

<Response>                                             
  <Result>                                             <!--Array of 'Item'--> 
    <Item>                                             
      <DocumentID>long</DocumentID>                    <!--Document number (unique ID)--> 
      <DocumentDate>datetime</DocumentDate>            <!--Document date (primary date)--> 
      <FileID>long</FileID>                            <!--Unique file ID--> 
      <ContactID>long</ContactID>                      <!--Contact number (primary contact)--> 
      <DocumentName>string</DocumentName>              <!--Document description--> 
      <Attributes>int</Attributes>                     <!--Document attributes (flags)--> 
      <Folder>string</Folder>                          <!--Folder path--> 
      <DocumentExtension>string</DocumentExtension>    <!--File extension--> 
      <Pages>int</Pages>                               <!--Page count (if known)--> 
      <DocumentType>string</DocumentType>              <!--Name of document type--> 
      <InReplyToID>long</InReplyToID>                  <!--In reply to document number--> 
      <CreatedDate>datetime</CreatedDate>              <!--Created/uploaded date--> 
      <ModifiedDate>datetime</ModifiedDate>            <!--Metadata last modified date--> 
      <FileNumber>string</FileNumber>                  <!--Human-readable file number--> 
      <Url>string</Url>                                <!--Location--> 
    </Item>                                            
  </Result>                                            
  <Message>string</Message>                            <!--Error message--> 
</Response>

{                                       
   "Result": [{                         
      "DocumentID": "long",             // Document number (unique ID)
      "DocumentDate": "datetime",       // Document date (primary date)
      "FileID": "long",                 // Unique file ID
      "ContactID": "long",              // Contact number (primary contact)
      "DocumentName": "string",         // Document description
      "Attributes": "int",              // Document attributes (flags)
      "Folder": "string",               // Folder path
      "DocumentExtension": "string",    // File extension
      "Pages": "int",                   // Page count (if known)
      "DocumentType": "string",         // Name of document type
      "InReplyToID": "long",            // In reply to document number
      "CreatedDate": "datetime",        // Created/uploaded date
      "ModifiedDate": "datetime",       // Metadata last modified date
      "FileNumber": "string",           // Human-readable file number
      "Url": "string"                   // Location
   }],                                  
   "Message": "string"                  // Error message
}

Status Codes

Code	Condition
200 OK	The operation completed successfully.
400 Bad Request	Invalid tag.
401 Unauthorized	Access token is invalid, expired or not specified.
406 Not Acceptable	Content type specified in the Accept header isn't supported.
500 Internal Server Error	An internal error occurred.