GET api/Swiftpage/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

swiftpageCustomerGet
NameDescriptionTypeAdditional information
CustomerName

string

None.

CRMID

string

None.

PortalSecurityRolesId

integer

None.

Status

string

None.

Message

string

None.

statusCode

integer

None.

AdditionalSendLimit

integer

None.

EmailSent

integer

None.

EmailLimit

integer

None.

SMSSent

integer

None.

SMSLimit

integer

None.

SMSReceived

integer

None.

SparkPost

Collection of MailServer

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerName": "sample string 1",
  "CRMID": "sample string 2",
  "PortalSecurityRolesId": 3,
  "Status": "sample string 4",
  "Message": "sample string 5",
  "statusCode": 6,
  "AdditionalSendLimit": 7,
  "EmailSent": 8,
  "EmailLimit": 9,
  "SMSSent": 10,
  "SMSLimit": 11,
  "SMSReceived": 12,
  "SparkPost": [
    {
      "Id": "sample string 1",
      "CustomerId": "sample string 2",
      "APIKey": "sample string 3",
      "SubAccountId": "sample string 4",
      "DomainName": "sample string 5",
      "ClickURL": "sample string 6"
    },
    {
      "Id": "sample string 1",
      "CustomerId": "sample string 2",
      "APIKey": "sample string 3",
      "SubAccountId": "sample string 4",
      "DomainName": "sample string 5",
      "ClickURL": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<swiftpageCustomerGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <AdditionalSendLimit>7</AdditionalSendLimit>
  <CRMID>sample string 2</CRMID>
  <CustomerName>sample string 1</CustomerName>
  <EmailLimit>9</EmailLimit>
  <EmailSent>8</EmailSent>
  <Message>sample string 5</Message>
  <PortalSecurityRolesId>3</PortalSecurityRolesId>
  <SMSLimit>11</SMSLimit>
  <SMSReceived>12</SMSReceived>
  <SMSSent>10</SMSSent>
  <SparkPost>
    <MailServer>
      <APIKey>sample string 3</APIKey>
      <ClickURL>sample string 6</ClickURL>
      <CustomerId>sample string 2</CustomerId>
      <DomainName>sample string 5</DomainName>
      <Id>sample string 1</Id>
      <SubAccountId>sample string 4</SubAccountId>
    </MailServer>
    <MailServer>
      <APIKey>sample string 3</APIKey>
      <ClickURL>sample string 6</ClickURL>
      <CustomerId>sample string 2</CustomerId>
      <DomainName>sample string 5</DomainName>
      <Id>sample string 1</Id>
      <SubAccountId>sample string 4</SubAccountId>
    </MailServer>
  </SparkPost>
  <Status>sample string 4</Status>
  <statusCode>6</statusCode>
</swiftpageCustomerGet>