GET 3dCartWebAPI/v1/CRM


Get all CRMs

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subject

Subject of the CRM

string

Default value is

departmentid

Department of the CRM

integer

Default value is 0

statusid

Status of the CRM

integer

Default value is 0

openedstartdate

Date Opened (mm/dd/yyyy hh:mm:ss)

string

Default value is

openedenddate

Date Last Action (mm/dd/yyyy hh:mm:ss)

string

Default value is

lastactionstartdate

Date Opened (mm/dd/yyyy hh:mm:ss)

string

Default value is

lastactionenddate

Date Last Action (mm/dd/yyyy hh:mm:ss)

string

Default value is

customername

Customer Name

string

Default value is

customeremail

Customer Email

string

Default value is

customerphone

Customer Phone

string

Default value is

customeripaddress

Customer Ip Address

string

Default value is

orderid

Order Id associated with the CRM

integer

Default value is 0

custid

Customer Id associated with the CRM

integer

Default value is 0

productid

Product Id associated with the CRM

integer

Default value is 0

limit

Maximum number of items that can be returned

integer

Default value is 10

offset

Starting point for the return data

integer

Default value is 1

countonly

Count the number of rows only

integer

Default value is 0

Body Parameters

None.


Sample Request



Response Information

Resource Description

Collection of CRM
NameDescriptionTypeAdditional information
CrmID

Primary key. Auto-incremented. database reference = CRM.id

integer

None.

DateOpened

database reference = CRM.datentime

date

None.

DateLastAction

database reference = CRM.lastactiondatentime

date

None.

Subject

database reference = CRM.subject

string

String length: inclusive between 0 and 50

DepartmentID

database reference = CRM.departmentid

integer

None.

StatusID

database reference = CRM.status

integer

None.

CustomerName

database reference = CRM.customer

string

String length: inclusive between 0 and 255

CustomerEmail

database reference = CRM.custemail

string

Required

String length: inclusive between 0 and 100

CustomerPhone

database reference = CRM.phone

string

String length: inclusive between 0 and 50

CustomerIpAddress

database reference = CRM.custip

string

String length: inclusive between 0 and 50

OrderID

database reference = CRM.orderid

integer

None.

CustomerID

database reference = CRM.custid

integer

None.

ProductId

database reference = CRM.productid

integer

None.

CrmMessageList

Collection of CrmMessage

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CrmID": 1,
    "DateOpened": "08/17/2019 17:20",
    "DateLastAction": "08/17/2019 17:20",
    "Subject": "sample string 1",
    "DepartmentID": 1,
    "StatusID": 1,
    "CustomerName": "sample string 2",
    "CustomerEmail": "sample string 3",
    "CustomerPhone": "sample string 4",
    "CustomerIpAddress": "sample string 5",
    "OrderID": 1,
    "CustomerID": 1,
    "ProductId": 1,
    "CrmMessageList": [
      {
        "MessageId": 1,
        "DateCreated": "08/17/2019 17:20",
        "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": "08/17/2019 17:20",
            "IsAdminUploaded": true
          },
          {
            "FileId": 1,
            "FileName": "sample string 1",
            "DateCreated": "08/17/2019 17:20",
            "IsAdminUploaded": true
          }
        ]
      },
      {
        "MessageId": 1,
        "DateCreated": "08/17/2019 17:20",
        "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": "08/17/2019 17:20",
            "IsAdminUploaded": true
          },
          {
            "FileId": 1,
            "FileName": "sample string 1",
            "DateCreated": "08/17/2019 17:20",
            "IsAdminUploaded": true
          }
        ]
      }
    ]
  },
  {
    "CrmID": 1,
    "DateOpened": "08/17/2019 17:20",
    "DateLastAction": "08/17/2019 17:20",
    "Subject": "sample string 1",
    "DepartmentID": 1,
    "StatusID": 1,
    "CustomerName": "sample string 2",
    "CustomerEmail": "sample string 3",
    "CustomerPhone": "sample string 4",
    "CustomerIpAddress": "sample string 5",
    "OrderID": 1,
    "CustomerID": 1,
    "ProductId": 1,
    "CrmMessageList": [
      {
        "MessageId": 1,
        "DateCreated": "08/17/2019 17:20",
        "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": "08/17/2019 17:20",
            "IsAdminUploaded": true
          },
          {
            "FileId": 1,
            "FileName": "sample string 1",
            "DateCreated": "08/17/2019 17:20",
            "IsAdminUploaded": true
          }
        ]
      },
      {
        "MessageId": 1,
        "DateCreated": "08/17/2019 17:20",
        "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": "08/17/2019 17:20",
            "IsAdminUploaded": true
          },
          {
            "FileId": 1,
            "FileName": "sample string 1",
            "DateCreated": "08/17/2019 17:20",
            "IsAdminUploaded": true
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfCRM xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CRM>
    <CrmID>1</CrmID>
    <DateOpened>2019-08-17T17:20:40.4770699-04:00</DateOpened>
    <DateLastAction>2019-08-17T17:20:40.4770699-04:00</DateLastAction>
    <Subject>sample string 1</Subject>
    <DepartmentID>1</DepartmentID>
    <StatusID>1</StatusID>
    <CustomerName>sample string 2</CustomerName>
    <CustomerEmail>sample string 3</CustomerEmail>
    <CustomerPhone>sample string 4</CustomerPhone>
    <CustomerIpAddress>sample string 5</CustomerIpAddress>
    <OrderID>1</OrderID>
    <CustomerID>1</CustomerID>
    <ProductId>1</ProductId>
    <CrmMessageList>
      <CrmMessage>
        <MessageId>1</MessageId>
        <DateCreated>2019-08-17T17:20:40.4770699-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>2019-08-17T17:20:40.4770699-04:00</DateCreated>
            <IsAdminUploaded>true</IsAdminUploaded>
          </CrmFile>
          <CrmFile>
            <FileId>1</FileId>
            <FileName>sample string 1</FileName>
            <DateCreated>2019-08-17T17:20:40.4770699-04:00</DateCreated>
            <IsAdminUploaded>true</IsAdminUploaded>
          </CrmFile>
        </CrmFileList>
      </CrmMessage>
      <CrmMessage>
        <MessageId>1</MessageId>
        <DateCreated>2019-08-17T17:20:40.4770699-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>2019-08-17T17:20:40.4770699-04:00</DateCreated>
            <IsAdminUploaded>true</IsAdminUploaded>
          </CrmFile>
          <CrmFile>
            <FileId>1</FileId>
            <FileName>sample string 1</FileName>
            <DateCreated>2019-08-17T17:20:40.4770699-04:00</DateCreated>
            <IsAdminUploaded>true</IsAdminUploaded>
          </CrmFile>
        </CrmFileList>
      </CrmMessage>
    </CrmMessageList>
  </CRM>
  <CRM>
    <CrmID>1</CrmID>
    <DateOpened>2019-08-17T17:20:40.4770699-04:00</DateOpened>
    <DateLastAction>2019-08-17T17:20:40.4770699-04:00</DateLastAction>
    <Subject>sample string 1</Subject>
    <DepartmentID>1</DepartmentID>
    <StatusID>1</StatusID>
    <CustomerName>sample string 2</CustomerName>
    <CustomerEmail>sample string 3</CustomerEmail>
    <CustomerPhone>sample string 4</CustomerPhone>
    <CustomerIpAddress>sample string 5</CustomerIpAddress>
    <OrderID>1</OrderID>
    <CustomerID>1</CustomerID>
    <ProductId>1</ProductId>
    <CrmMessageList>
      <CrmMessage>
        <MessageId>1</MessageId>
        <DateCreated>2019-08-17T17:20:40.4770699-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>2019-08-17T17:20:40.4770699-04:00</DateCreated>
            <IsAdminUploaded>true</IsAdminUploaded>
          </CrmFile>
          <CrmFile>
            <FileId>1</FileId>
            <FileName>sample string 1</FileName>
            <DateCreated>2019-08-17T17:20:40.4770699-04:00</DateCreated>
            <IsAdminUploaded>true</IsAdminUploaded>
          </CrmFile>
        </CrmFileList>
      </CrmMessage>
      <CrmMessage>
        <MessageId>1</MessageId>
        <DateCreated>2019-08-17T17:20:40.4770699-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>2019-08-17T17:20:40.4770699-04:00</DateCreated>
            <IsAdminUploaded>true</IsAdminUploaded>
          </CrmFile>
          <CrmFile>
            <FileId>1</FileId>
            <FileName>sample string 1</FileName>
            <DateCreated>2019-08-17T17:20:40.4770699-04:00</DateCreated>
            <IsAdminUploaded>true</IsAdminUploaded>
          </CrmFile>
        </CrmFileList>
      </CrmMessage>
    </CrmMessageList>
  </CRM>
</ArrayOfCRM>