POST Agents/Document/CreateDefaultSuggestedDocumentEntity

• 2 minutes to read
 • 2 minutes to read 
POST /api/v1/Agents/Document/CreateDefaultSuggestedDocumentEntity

Set default values into a new SuggestedDocumentEntity.

NetServer calculates default values on the entity, which is required when creating/storing a new instance

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: SuggestedDocumentEntity

Property Name Type Description
SuggestedDocumentId int32 Primary key
Name string Item name, visible in Guide
Tooltip string Tooltip / description
Rank int32 Rank, controls rank of non-instantiated items in Guide
DoctmplId int32 Type of the suggested document
Header string Suggested 'header'
OurRef string Suggested 'our reference'
Deleted bool 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists
DocTmpl DocumentTemplate Document template
ProjectTypeStatusLink ProjectTypeStatusLink Project type and project status link info
SaleTypeStageLink SaleTypeStageLink Sale type and stage link info.
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/CreateDefaultSuggestedDocumentEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

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

{
  "SuggestedDocumentId": 58,
  "Name": "Donnelly, Mitchell and Considine",
  "Tooltip": "velit",
  "Rank": 873,
  "DoctmplId": 117,
  "Header": "fugit",
  "OurRef": "deserunt",
  "Deleted": false,
  "DocTmpl": null,
  "ProjectTypeStatusLink": null,
  "SaleTypeStageLink": null,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 339
    }
  }
}