POST Agents/Document/GetDocument

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Document/GetDocument

Gets a Document object.

NsApiSlow threshold: 1000 ms.

Query String Parameters

Parameter Name Type Description
documentId int32 Required The identifier of the Document object
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Document/GetDocument?documentId=323
POST /api/v1/Agents/Document/GetDocument?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: Document

Property Name Type Description
DocumentId int32 Primary key
Attention string Attention/salutation
Header string Visible document name
Name string File name
OurRef string Our reference, searchable field from freetext search
YourRef string Your reference
Description string The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases
DocumentTemplate string
IsPublished bool True if document have an entry in published table
PersonId int32 Person ID of person the appointment is with, may be 0
PersonFullName string The full name of the person this document belongs to.
AssociateFullName string The associate's culture formatted fullname (firstname, middleName and lastname)
ContactId int32 Contact ID of owning contact, may be 0
ContactName string Contact name
ProjectId int32 ID of project referred to, may be 0
ProjectName string Project name
AssociateId int32 ID of associate whose diary the appointment is in, REQUIRED
Snum int32 The sequence number allocated from refcount on used template when creating the document
SaleId int32 Owning sale, if any (may be 0)
SaleName string Heading of Owning sale, if any. (may be blank)
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Document/GetDocument
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "DocumentId": 911,
  "Attention": "Board Members",
  "Header": "Annual Budget 2024",
  "Name": "Annual_Budget_2024.xlsx",
  "OurRef": "FIN-BUD-2024-001",
  "YourRef": "BUDGET-2024",
  "Description": "Detailed annual budget with departmental allocations and projections for 2024",
  "DocumentTemplate": "Budget Spreadsheet Template",
  "IsPublished": true,
  "PersonId": 356,
  "PersonFullName": "Sarah Johnson",
  "AssociateFullName": "John Anderson",
  "ContactId": 934,
  "ContactName": "Acme Corporation",
  "ProjectId": 81,
  "ProjectName": "Financial Planning 2024",
  "AssociateId": 985,
  "Snum": 360,
  "SaleId": 694,
  "SaleName": "Financial Consulting Services",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 64
    }
  }
}