GET ShipmentMessage/{id}

Some tooltip text!

• 4 minutes to read

 • 4 minutes to read

GET /api/v1/ShipmentMessage/{id}

Gets a ShipmentMessageEntity object.

Calls the Marketing agent service GetShipmentMessageEntity. NsApiSlow threshold: 5000 ms.

Path Part	Type	Description
id	int32	The id of the ShipmentMessageEntity to return. Required

Query String Parameters

Parameter Name	Type	Description
$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.

GET /api/v1/ShipmentMessage/{id}?$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:

ShipmentMessageEntity found.

Response	Description
200	ShipmentMessageEntity found.
404	Not Found.

Response body: ShipmentMessageEntityWithLinks

Property Name	Type	Description
ShipmentMessageId	int32	Primary key
PlainMessage	string	Plain message text of this message
HtmlMessage	string	HTML formatted text of this message
SmsMessage	string	SMS version of this message
Description	string	Describes this message
Subject	string	The mail subject field of the message
FolderId	int32	The folder which this message belongs to. -1 indicates that the message is on the root
HeaderField	string	Extra header fields added to mail. Must be formatted correctly
Design	string	Will contain the design part of a message. The format will vary based on the type of designer used to create the message
Designtype	string	Enum containing the type of the design
Flags	string	Identifies if HTML or plain message is included in message.
RegisterViews	bool	Register message views?
InlineImages	bool	Should images be included inline?
LongDescription	string	A field for a long description of this template
AccessKey	string	Key used for access verification
DocumentMessage	int32	The SM document used as template for this mailing
Registered	date-time	Registered when in UTC.
RegisteredAssociateId	int32	Registered by whom
Updated	date-time	Last updated when in UTC.
UpdatedAssociateId	int32	Last updated by whom
UpdatedCount	int32	Number of updates made to this record
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.
_Links	object

Sample request

GET /api/v1/ShipmentMessage/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 ShipmentMessageEntity found.
Content-Type: application/json; charset=utf-8

{
  "ShipmentMessageId": 464,
  "PlainMessage": "quia",
  "HtmlMessage": "id",
  "SmsMessage": "veniam",
  "Description": "Multi-tiered holistic encryption",
  "Subject": "cupiditate",
  "FolderId": 799,
  "HeaderField": "et",
  "Design": "necessitatibus",
  "Designtype": "SOEditor",
  "Flags": "Document",
  "RegisterViews": false,
  "InlineImages": true,
  "LongDescription": "Realigned coherent access",
  "AccessKey": "deserunt",
  "DocumentMessage": 697,
  "Registered": "2000-01-07T02:30:52.9442767+01:00",
  "RegisteredAssociateId": 147,
  "Updated": "2022-07-28T02:30:52.9442767+02:00",
  "UpdatedAssociateId": 419,
  "UpdatedCount": 522,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 389
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}