GET 3dCartWebAPI/v1/CRM/{crmid}/message/{msgid}
Get a specific Message
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
crmid |
CRM ID |
integer |
Required |
msgid |
Message ID |
integer |
Required |
Body Parameters
None.
Sample Request |
|
Response Information
Resource Description
Collection of CrmMessageName | 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": "03/28/2024 06:18", "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": "03/28/2024 06:18", "IsAdminUploaded": true }, { "FileId": 1, "FileName": "sample string 1", "DateCreated": "03/28/2024 06:18", "IsAdminUploaded": true } ] }, { "MessageId": 1, "DateCreated": "03/28/2024 06:18", "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": "03/28/2024 06:18", "IsAdminUploaded": true }, { "FileId": 1, "FileName": "sample string 1", "DateCreated": "03/28/2024 06:18", "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-03-28T06:18:53.5507872-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-03-28T06:18:53.5507872-04:00</DateCreated> <IsAdminUploaded>true</IsAdminUploaded> </CrmFile> <CrmFile> <FileId>1</FileId> <FileName>sample string 1</FileName> <DateCreated>2024-03-28T06:18:53.5507872-04:00</DateCreated> <IsAdminUploaded>true</IsAdminUploaded> </CrmFile> </CrmFileList> </CrmMessage> <CrmMessage> <MessageId>1</MessageId> <DateCreated>2024-03-28T06:18:53.5507872-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-03-28T06:18:53.5507872-04:00</DateCreated> <IsAdminUploaded>true</IsAdminUploaded> </CrmFile> <CrmFile> <FileId>1</FileId> <FileName>sample string 1</FileName> <DateCreated>2024-03-28T06:18:53.5507872-04:00</DateCreated> <IsAdminUploaded>true</IsAdminUploaded> </CrmFile> </CrmFileList> </CrmMessage> </ArrayOfCrmMessage>