GET 3dCartWebAPI/v1/CRM/{crmid}/message?limit={limit}&offset={offset}

GET 3dCartWebAPI/v1/CRM/{crmid}/message

Get all the messages from a specific CRM

Request Information

URI Parameters

Name	Description	Type	Additional information
crmid	CRM ID	integer	Default value is 0
limit	Maximum number of items that can be returned	integer	Default value is 0
offset	Starting point for the return data	integer	Default value is 0

Body Parameters

None.

Sample Request

PHP

Python

Ruby

Response Information

Resource Description

Collection of CrmMessage

Name	Description	Type	Additional information
MessageId	Primary key. Auto-incremented. database reference = CRM_messages.id	integer	None.
DateCreated	database reference = CRM_messages.datentime	date	None.
Message	database reference = CRM_messages.message	string	String length: inclusive between 0 and 65535
Sender	database reference = CRM_messages.sender	integer	None.
SenderName	database reference = CRM_messages.sendername	string	String length: inclusive between 0 and 150
SenderEmail	database reference = CRM_messages.senderemail	string	String length: inclusive between 0 and 100
CustomerIPAddress	database reference = CRM_messages.custip	string	String length: inclusive between 0 and 16
CrmFileList		Collection of CrmFile	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MessageId": 1,
    "DateCreated": "04/16/2024 07:12",
    "Message": "sample string 1",
    "Sender": 1,
    "SenderName": "sample string 2",
    "SenderEmail": "sample string 3",
    "CustomerIPAddress": "sample string 4",
    "CrmFileList": [
      {
        "FileId": 1,
        "FileName": "sample string 1",
        "DateCreated": "04/16/2024 07:12",
        "IsAdminUploaded": true
      },
      {
        "FileId": 1,
        "FileName": "sample string 1",
        "DateCreated": "04/16/2024 07:12",
        "IsAdminUploaded": true
      }
    ]
  },
  {
    "MessageId": 1,
    "DateCreated": "04/16/2024 07:12",
    "Message": "sample string 1",
    "Sender": 1,
    "SenderName": "sample string 2",
    "SenderEmail": "sample string 3",
    "CustomerIPAddress": "sample string 4",
    "CrmFileList": [
      {
        "FileId": 1,
        "FileName": "sample string 1",
        "DateCreated": "04/16/2024 07:12",
        "IsAdminUploaded": true
      },
      {
        "FileId": 1,
        "FileName": "sample string 1",
        "DateCreated": "04/16/2024 07:12",
        "IsAdminUploaded": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCrmMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CrmMessage>
    <MessageId>1</MessageId>
    <DateCreated>2024-04-16T07:12:39.1474416-04:00</DateCreated>
    <Message>sample string 1</Message>
    <Sender>1</Sender>
    <SenderName>sample string 2</SenderName>
    <SenderEmail>sample string 3</SenderEmail>
    <CustomerIPAddress>sample string 4</CustomerIPAddress>
    <CrmFileList>
      <CrmFile>
        <FileId>1</FileId>
        <FileName>sample string 1</FileName>
        <DateCreated>2024-04-16T07:12:39.1474416-04:00</DateCreated>
        <IsAdminUploaded>true</IsAdminUploaded>
      </CrmFile>
      <CrmFile>
        <FileId>1</FileId>
        <FileName>sample string 1</FileName>
        <DateCreated>2024-04-16T07:12:39.1474416-04:00</DateCreated>
        <IsAdminUploaded>true</IsAdminUploaded>
      </CrmFile>
    </CrmFileList>
  </CrmMessage>
  <CrmMessage>
    <MessageId>1</MessageId>
    <DateCreated>2024-04-16T07:12:39.1474416-04:00</DateCreated>
    <Message>sample string 1</Message>
    <Sender>1</Sender>
    <SenderName>sample string 2</SenderName>
    <SenderEmail>sample string 3</SenderEmail>
    <CustomerIPAddress>sample string 4</CustomerIPAddress>
    <CrmFileList>
      <CrmFile>
        <FileId>1</FileId>
        <FileName>sample string 1</FileName>
        <DateCreated>2024-04-16T07:12:39.1474416-04:00</DateCreated>
        <IsAdminUploaded>true</IsAdminUploaded>
      </CrmFile>
      <CrmFile>
        <FileId>1</FileId>
        <FileName>sample string 1</FileName>
        <DateCreated>2024-04-16T07:12:39.1474416-04:00</DateCreated>
        <IsAdminUploaded>true</IsAdminUploaded>
      </CrmFile>
    </CrmFileList>
  </CrmMessage>
</ArrayOfCrmMessage>