POST api/printing/preview

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
iSaleorderID	integer	None.
SaleorderRef	string	None.
systemSetting	Collection of systemSetting	None.
companyDetails	CompanyDetails	None.
DealerCode	string	None.
LogedInSiteID	integer	None.
LogedInUserID	integer	None.
CurrencyID	integer	None.
CurrencySymbol	string	None.
ReportPrinter	string	None.
bSiteAddress	boolean	None.
LogedInSiteName	string	None.
customizableReportSiteChannel	Collection of CustomizableReportSiteChannel	None.
iInvoiceID	integer	None.
bLogoNotRequired	boolean	None.
bDisplayPaymentTermsOnInvoice	boolean	None.
InvoiceFormat	integer	None.
InvoicePrinterName	string	None.
NoOfInvoiceCopy	integer	None.
CreditNotePrinterName	string	None.
UseDefaultPrinter	boolean	None.
CreditNoteFormat	integer	None.
printEmailData	printEmailData	None.
bIsDirectPrinting	boolean	None.
DespatchID	integer	None.
ReceiptPrinter	string	None.
IsReceiptPrinter	boolean	None.
ChannelID	integer	None.
siteDetails	SiteDetails	None.
siteChanelDetails	Collection of SiteChanelDetails	None.
ServerPath	string	None.
OwsPRinterPath	string	None.
UtilityAPIURL	string	None.
wsExternalUtilityURL	string	None.
EmailText	string	None.
UserName	string	None.
Password	string	None.
LogPath	string	None.
CustomizableReportTemplateID	integer	None.
CustomizableReportTypeID	integer	None.
CustomizableReportDocTypeID	integer	None.
ContractList	Collection of ConnectionItem	None.
CurrentWorkstationID	integer	None.
Method	string	None.
IsIntegrationNetworkSelected	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "iSaleorderID": 1,
  "SaleorderRef": "sample string 2",
  "systemSetting": [
    {
      "ID": 1,
      "Value": "sample string 2"
    },
    {
      "ID": 1,
      "Value": "sample string 2"
    }
  ],
  "companyDetails": {
    "bUseSiteLogoInDespatchDocuments": true,
    "Picture": "sample string 2",
    "ImageWidth": 3,
    "ImageHeight": 4,
    "bLogoinActualSize": true,
    "CompanyRegNumber": "sample string 6",
    "VatRegNumber": "sample string 7",
    "TradingName": "sample string 8",
    "ReceiptGreeting": "sample string 9",
    "RegisteredName": "sample string 10",
    "FullAddress": "sample string 11"
  },
  "DealerCode": "sample string 3",
  "LogedInSiteID": 4,
  "LogedInUserID": 5,
  "CurrencyID": 6,
  "CurrencySymbol": "sample string 7",
  "ReportPrinter": "sample string 8",
  "bSiteAddress": true,
  "LogedInSiteName": "sample string 10",
  "customizableReportSiteChannel": [
    {
      "CustomizableReportSiteChannelID": 1,
      "SiteID": 2,
      "ChannelID": 3,
      "CustomizableReportTypeID": 4,
      "CustomizableReportTemplateID": 5,
      "CustomizableReportDocTypeID": 6
    },
    {
      "CustomizableReportSiteChannelID": 1,
      "SiteID": 2,
      "ChannelID": 3,
      "CustomizableReportTypeID": 4,
      "CustomizableReportTemplateID": 5,
      "CustomizableReportDocTypeID": 6
    }
  ],
  "iInvoiceID": 11,
  "bLogoNotRequired": true,
  "bDisplayPaymentTermsOnInvoice": true,
  "InvoiceFormat": 14,
  "InvoicePrinterName": "sample string 15",
  "NoOfInvoiceCopy": 16,
  "CreditNotePrinterName": "sample string 17",
  "UseDefaultPrinter": true,
  "CreditNoteFormat": 19,
  "printEmailData": {
    "Email": "sample string 1",
    "Name": "sample string 2",
    "Username": "sample string 3",
    "Password": "sample string 4",
    "IsMarketingAllowed": true,
    "IsReceipt": true,
    "NoOfCopyReceipt": 7,
    "IsInvoice": true,
    "NoOfCopyInvoice": 9,
    "IsContract": true,
    "NoOfCopyContract": 11,
    "IsCashBack": true,
    "IsDespatchNote": true,
    "IsTermsAndConditions": true,
    "IsConnectionList": true,
    "IsConnection": true,
    "NoOfCopyCashBack": 17,
    "IsInsuaranceApp": true,
    "NoOfCopyInsuaranceApp": 19,
    "IsEmailInvoice": true,
    "IsEmailReceipt": true,
    "IsVoucher": true,
    "IsWelcomeLetter": true,
    "IsEmailWelcomeLetter": true,
    "IsEmailEmailReceipt": true,
    "IsEmailContractAgreement": true,
    "IsETopUp": true,
    "VoucherPartialyRedeemRef": "sample string 28"
  },
  "bIsDirectPrinting": true,
  "DespatchID": 21,
  "ReceiptPrinter": "sample string 22",
  "IsReceiptPrinter": true,
  "ChannelID": 24,
  "siteDetails": {
    "bUseSiteLogoInDespatchDocuments": true,
    "Picture": "sample string 2",
    "Name": "sample string 3",
    "SiteID": 4
  },
  "siteChanelDetails": [
    {
      "ChannelID": 1,
      "bHideTrackableDataonDespatch": "sample string 2"
    },
    {
      "ChannelID": 1,
      "bHideTrackableDataonDespatch": "sample string 2"
    }
  ],
  "ServerPath": "sample string 25",
  "OwsPRinterPath": "sample string 26",
  "UtilityAPIURL": "sample string 27",
  "wsExternalUtilityURL": "sample string 28",
  "EmailText": "sample string 29",
  "UserName": "sample string 30",
  "Password": "sample string 31",
  "LogPath": "sample string 32",
  "CustomizableReportTemplateID": 33,
  "CustomizableReportTypeID": 34,
  "CustomizableReportDocTypeID": 35,
  "ContractList": [
    {
      "ConnectionID": 1,
      "ConnectionRef": "sample string 2",
      "strConnectionDate": "sample string 3",
      "strCreatedDate": "sample string 4",
      "VBCLimit": "sample string 5",
      "PhoneNumber": "sample string 6",
      "IsIntegrationNetworkSelected": true
    },
    {
      "ConnectionID": 1,
      "ConnectionRef": "sample string 2",
      "strConnectionDate": "sample string 3",
      "strCreatedDate": "sample string 4",
      "VBCLimit": "sample string 5",
      "PhoneNumber": "sample string 6",
      "IsIntegrationNetworkSelected": true
    }
  ],
  "CurrentWorkstationID": 36,
  "Method": "sample string 37",
  "IsIntegrationNetworkSelected": true
}

application/xml, text/xml

Sample:

<PrintModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models">
  <ChannelID>24</ChannelID>
  <ContractList>
    <ConnectionItem>
      <ConnectionID>1</ConnectionID>
      <ConnectionRef>sample string 2</ConnectionRef>
      <IsIntegrationNetworkSelected>true</IsIntegrationNetworkSelected>
      <PhoneNumber>sample string 6</PhoneNumber>
      <VBCLimit>sample string 5</VBCLimit>
      <strConnectionDate>sample string 3</strConnectionDate>
      <strCreatedDate>sample string 4</strCreatedDate>
    </ConnectionItem>
    <ConnectionItem>
      <ConnectionID>1</ConnectionID>
      <ConnectionRef>sample string 2</ConnectionRef>
      <IsIntegrationNetworkSelected>true</IsIntegrationNetworkSelected>
      <PhoneNumber>sample string 6</PhoneNumber>
      <VBCLimit>sample string 5</VBCLimit>
      <strConnectionDate>sample string 3</strConnectionDate>
      <strCreatedDate>sample string 4</strCreatedDate>
    </ConnectionItem>
  </ContractList>
  <CreditNoteFormat>19</CreditNoteFormat>
  <CreditNotePrinterName>sample string 17</CreditNotePrinterName>
  <CurrencyID>6</CurrencyID>
  <CurrencySymbol>sample string 7</CurrencySymbol>
  <CurrentWorkstationID>36</CurrentWorkstationID>
  <CustomizableReportDocTypeID>35</CustomizableReportDocTypeID>
  <CustomizableReportTemplateID>33</CustomizableReportTemplateID>
  <CustomizableReportTypeID>34</CustomizableReportTypeID>
  <DealerCode>sample string 3</DealerCode>
  <DespatchID>21</DespatchID>
  <EmailText>sample string 29</EmailText>
  <InvoiceFormat>14</InvoiceFormat>
  <InvoicePrinterName>sample string 15</InvoicePrinterName>
  <IsIntegrationNetworkSelected>true</IsIntegrationNetworkSelected>
  <IsReceiptPrinter>true</IsReceiptPrinter>
  <LogPath>sample string 32</LogPath>
  <LogedInSiteID>4</LogedInSiteID>
  <LogedInSiteName>sample string 10</LogedInSiteName>
  <LogedInUserID>5</LogedInUserID>
  <Method>sample string 37</Method>
  <NoOfInvoiceCopy>16</NoOfInvoiceCopy>
  <OwsPRinterPath>sample string 26</OwsPRinterPath>
  <Password>sample string 31</Password>
  <ReceiptPrinter>sample string 22</ReceiptPrinter>
  <ReportPrinter>sample string 8</ReportPrinter>
  <SaleorderRef>sample string 2</SaleorderRef>
  <ServerPath>sample string 25</ServerPath>
  <UseDefaultPrinter>true</UseDefaultPrinter>
  <UserName>sample string 30</UserName>
  <UtilityAPIURL>sample string 27</UtilityAPIURL>
  <bDisplayPaymentTermsOnInvoice>true</bDisplayPaymentTermsOnInvoice>
  <bIsDirectPrinting>true</bIsDirectPrinting>
  <bLogoNotRequired>true</bLogoNotRequired>
  <bSiteAddress>true</bSiteAddress>
  <companyDetails>
    <CompanyRegNumber>sample string 6</CompanyRegNumber>
    <FullAddress>sample string 11</FullAddress>
    <ImageHeight>4</ImageHeight>
    <ImageWidth>3</ImageWidth>
    <Picture>sample string 2</Picture>
    <ReceiptGreeting>sample string 9</ReceiptGreeting>
    <RegisteredName>sample string 10</RegisteredName>
    <TradingName>sample string 8</TradingName>
    <VatRegNumber>sample string 7</VatRegNumber>
    <bLogoinActualSize>true</bLogoinActualSize>
    <bUseSiteLogoInDespatchDocuments>true</bUseSiteLogoInDespatchDocuments>
  </companyDetails>
  <customizableReportSiteChannel>
    <CustomizableReportSiteChannel>
      <ChannelID>3</ChannelID>
      <CustomizableReportDocTypeID>6</CustomizableReportDocTypeID>
      <CustomizableReportSiteChannelID>1</CustomizableReportSiteChannelID>
      <CustomizableReportTemplateID>5</CustomizableReportTemplateID>
      <CustomizableReportTypeID>4</CustomizableReportTypeID>
      <SiteID>2</SiteID>
    </CustomizableReportSiteChannel>
    <CustomizableReportSiteChannel>
      <ChannelID>3</ChannelID>
      <CustomizableReportDocTypeID>6</CustomizableReportDocTypeID>
      <CustomizableReportSiteChannelID>1</CustomizableReportSiteChannelID>
      <CustomizableReportTemplateID>5</CustomizableReportTemplateID>
      <CustomizableReportTypeID>4</CustomizableReportTypeID>
      <SiteID>2</SiteID>
    </CustomizableReportSiteChannel>
  </customizableReportSiteChannel>
  <iInvoiceID>11</iInvoiceID>
  <iSaleorderID>1</iSaleorderID>
  <printEmailData>
    <Email>sample string 1</Email>
    <IsCashBack>true</IsCashBack>
    <IsConnection>true</IsConnection>
    <IsConnectionList>true</IsConnectionList>
    <IsContract>true</IsContract>
    <IsDespatchNote>true</IsDespatchNote>
    <IsETopUp>true</IsETopUp>
    <IsEmailContractAgreement>true</IsEmailContractAgreement>
    <IsEmailEmailReceipt>true</IsEmailEmailReceipt>
    <IsEmailInvoice>true</IsEmailInvoice>
    <IsEmailReceipt>true</IsEmailReceipt>
    <IsEmailWelcomeLetter>true</IsEmailWelcomeLetter>
    <IsInsuaranceApp>true</IsInsuaranceApp>
    <IsInvoice>true</IsInvoice>
    <IsMarketingAllowed>true</IsMarketingAllowed>
    <IsReceipt>true</IsReceipt>
    <IsTermsAndConditions>true</IsTermsAndConditions>
    <IsVoucher>true</IsVoucher>
    <IsWelcomeLetter>true</IsWelcomeLetter>
    <Name>sample string 2</Name>
    <NoOfCopyCashBack>17</NoOfCopyCashBack>
    <NoOfCopyContract>11</NoOfCopyContract>
    <NoOfCopyInsuaranceApp>19</NoOfCopyInsuaranceApp>
    <NoOfCopyInvoice>9</NoOfCopyInvoice>
    <NoOfCopyReceipt>7</NoOfCopyReceipt>
    <Password>sample string 4</Password>
    <Username>sample string 3</Username>
    <VoucherPartialyRedeemRef>sample string 28</VoucherPartialyRedeemRef>
  </printEmailData>
  <siteChanelDetails>
    <SiteChanelDetails>
      <ChannelID>1</ChannelID>
      <bHideTrackableDataonDespatch>sample string 2</bHideTrackableDataonDespatch>
    </SiteChanelDetails>
    <SiteChanelDetails>
      <ChannelID>1</ChannelID>
      <bHideTrackableDataonDespatch>sample string 2</bHideTrackableDataonDespatch>
    </SiteChanelDetails>
  </siteChanelDetails>
  <siteDetails>
    <Name>sample string 3</Name>
    <Picture>sample string 2</Picture>
    <SiteID>4</SiteID>
    <bUseSiteLogoInDespatchDocuments>true</bUseSiteLogoInDespatchDocuments>
  </siteDetails>
  <systemSetting>
    <systemSetting>
      <ID>1</ID>
      <Value>sample string 2</Value>
    </systemSetting>
    <systemSetting>
      <ID>1</ID>
      <Value>sample string 2</Value>
    </systemSetting>
  </systemSetting>
  <wsExternalUtilityURL>sample string 28</wsExternalUtilityURL>
</PrintModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>