GET api/Customers

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
StatusCode	string	None.
Message	string	None.
customers	Collection of entitlementCustomers	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusCode": "sample string 1",
  "Message": "sample string 2",
  "customers": [
    {
      "PortalCustomersId": "sample string 1",
      "CustomerName": "sample string 2",
      "PortalSecurityRolesId": 3,
      "cnameCloudFront": "sample string 4",
      "cnameURLShortener": "sample string 5",
      "cnameLandingPages": "sample string 6",
      "InforEnabled": 7,
      "ActEnabled": 8,
      "SMSEnabled": 9,
      "CRMId": "sample string 10",
      "EmailSent": 11,
      "EmailLimit": 12,
      "SMSSent": 13,
      "SMSLimit": 14,
      "SMSReceived": 15
    },
    {
      "PortalCustomersId": "sample string 1",
      "CustomerName": "sample string 2",
      "PortalSecurityRolesId": 3,
      "cnameCloudFront": "sample string 4",
      "cnameURLShortener": "sample string 5",
      "cnameLandingPages": "sample string 6",
      "InforEnabled": 7,
      "ActEnabled": 8,
      "SMSEnabled": 9,
      "CRMId": "sample string 10",
      "EmailSent": 11,
      "EmailLimit": 12,
      "SMSSent": 13,
      "SMSLimit": 14,
      "SMSReceived": 15
    }
  ]
}

application/xml, text/xml

Sample:

<SMSRestAPIResponseCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <Message>sample string 2</Message>
  <StatusCode>sample string 1</StatusCode>
  <customers>
    <entitlementCustomers>
      <ActEnabled>8</ActEnabled>
      <CRMId>sample string 10</CRMId>
      <CustomerName>sample string 2</CustomerName>
      <EmailLimit>12</EmailLimit>
      <EmailSent>11</EmailSent>
      <InforEnabled>7</InforEnabled>
      <PortalCustomersId>sample string 1</PortalCustomersId>
      <PortalSecurityRolesId>3</PortalSecurityRolesId>
      <SMSEnabled>9</SMSEnabled>
      <SMSLimit>14</SMSLimit>
      <SMSReceived>15</SMSReceived>
      <SMSSent>13</SMSSent>
      <cnameCloudFront>sample string 4</cnameCloudFront>
      <cnameLandingPages>sample string 6</cnameLandingPages>
      <cnameURLShortener>sample string 5</cnameURLShortener>
    </entitlementCustomers>
    <entitlementCustomers>
      <ActEnabled>8</ActEnabled>
      <CRMId>sample string 10</CRMId>
      <CustomerName>sample string 2</CustomerName>
      <EmailLimit>12</EmailLimit>
      <EmailSent>11</EmailSent>
      <InforEnabled>7</InforEnabled>
      <PortalCustomersId>sample string 1</PortalCustomersId>
      <PortalSecurityRolesId>3</PortalSecurityRolesId>
      <SMSEnabled>9</SMSEnabled>
      <SMSLimit>14</SMSLimit>
      <SMSReceived>15</SMSReceived>
      <SMSSent>13</SMSSent>
      <cnameCloudFront>sample string 4</cnameCloudFront>
      <cnameLandingPages>sample string 6</cnameLandingPages>
      <cnameURLShortener>sample string 5</cnameURLShortener>
    </entitlementCustomers>
  </customers>
</SMSRestAPIResponseCustomer>