POST api/Download/CreatePDF

Request Information

URI Parameters

None.

Body Parameters

IdListPDF
NameDescriptionTypeAdditional information
Settings

PDFExportSettings

None.

Ids

List of Items IDs

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "settings": {
    "marginsLeft": 1.1,
    "marginsTop": 2.1,
    "marginsRight": 3.1,
    "pageSize": "6.1, 7.1",
    "marginsBottom": 4.1,
    "itemsBorder": 5.1,
    "pageWidth": 6.1,
    "pageHeight": 7.1,
    "columns": 8,
    "showBorder": true,
    "rows": 10,
    "captions": [
      [
        "ab609599-fdee-4afc-8b68-fb3a90645f44",
        "68317343-cb4e-4be9-aa49-54dba8e931d6"
      ],
      [
        "31c7102c-a674-4800-8477-7ccc6b0fe595",
        "d7597cc6-45b3-4000-8d83-b1defb5c408f"
      ]
    ],
    "captionsBorder": 11.1,
    "font": null,
    "fontName": "sample string 12",
    "fontStyle": 0,
    "captionEnables": [
      true,
      true
    ],
    "captionLines": [
      1,
      2
    ],
    "fontSize": 13.1
  },
  "ids": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<IdListPDF xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </Ids>
  <Settings xmlns:d2p1="http://schemas.datacontract.org/2004/07/PicaJet.Daminion.ClientCommon">
    <d2p1:_font xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Drawing" i:nil="true" />
    <d2p1:_x003C_CaptionEnables_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:boolean>true</d3p1:boolean>
      <d3p1:boolean>true</d3p1:boolean>
    </d2p1:_x003C_CaptionEnables_x003E_k__BackingField>
    <d2p1:_x003C_CaptionLines_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:_x003C_CaptionLines_x003E_k__BackingField>
    <d2p1:_x003C_CaptionsBorder_x003E_k__BackingField>11.1</d2p1:_x003C_CaptionsBorder_x003E_k__BackingField>
    <d2p1:_x003C_Captions_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfguid>
        <d3p1:guid>ab609599-fdee-4afc-8b68-fb3a90645f44</d3p1:guid>
        <d3p1:guid>68317343-cb4e-4be9-aa49-54dba8e931d6</d3p1:guid>
      </d3p1:ArrayOfguid>
      <d3p1:ArrayOfguid>
        <d3p1:guid>31c7102c-a674-4800-8477-7ccc6b0fe595</d3p1:guid>
        <d3p1:guid>d7597cc6-45b3-4000-8d83-b1defb5c408f</d3p1:guid>
      </d3p1:ArrayOfguid>
    </d2p1:_x003C_Captions_x003E_k__BackingField>
    <d2p1:_x003C_Columns_x003E_k__BackingField>8</d2p1:_x003C_Columns_x003E_k__BackingField>
    <d2p1:_x003C_FontName_x003E_k__BackingField>sample string 12</d2p1:_x003C_FontName_x003E_k__BackingField>
    <d2p1:_x003C_FontSize_x003E_k__BackingField>13.1</d2p1:_x003C_FontSize_x003E_k__BackingField>
    <d2p1:_x003C_FontStyle_x003E_k__BackingField>Regular</d2p1:_x003C_FontStyle_x003E_k__BackingField>
    <d2p1:_x003C_ItemsBorder_x003E_k__BackingField>5.1</d2p1:_x003C_ItemsBorder_x003E_k__BackingField>
    <d2p1:_x003C_MarginsBottom_x003E_k__BackingField>4.1</d2p1:_x003C_MarginsBottom_x003E_k__BackingField>
    <d2p1:_x003C_MarginsLeft_x003E_k__BackingField>1.1</d2p1:_x003C_MarginsLeft_x003E_k__BackingField>
    <d2p1:_x003C_MarginsRight_x003E_k__BackingField>3.1</d2p1:_x003C_MarginsRight_x003E_k__BackingField>
    <d2p1:_x003C_MarginsTop_x003E_k__BackingField>2.1</d2p1:_x003C_MarginsTop_x003E_k__BackingField>
    <d2p1:_x003C_PageHeight_x003E_k__BackingField>7.1</d2p1:_x003C_PageHeight_x003E_k__BackingField>
    <d2p1:_x003C_PageWidth_x003E_k__BackingField>6.1</d2p1:_x003C_PageWidth_x003E_k__BackingField>
    <d2p1:_x003C_Rows_x003E_k__BackingField>10</d2p1:_x003C_Rows_x003E_k__BackingField>
    <d2p1:_x003C_ShowBorder_x003E_k__BackingField>true</d2p1:_x003C_ShowBorder_x003E_k__BackingField>
  </Settings>
</IdListPDF>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'IdListPDF'.

Response Information

Resource Description

ObjResultOfString
NameDescriptionTypeAdditional information
Data

string

None.

Error

Error description if the operation failed

string

None.

Success

Operation result

boolean

None.

ErrorCode

Error code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "data": "sample string 1",
  "error": "sample string 2",
  "success": true,
  "errorCode": 4
}

application/xml, text/xml

Sample:
<ObjResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <_x003C_ErrorCode_x003E_k__BackingField>4</_x003C_ErrorCode_x003E_k__BackingField>
  <_x003C_Error_x003E_k__BackingField>sample string 2</_x003C_Error_x003E_k__BackingField>
  <_x003C_Success_x003E_k__BackingField>true</_x003C_Success_x003E_k__BackingField>
  <Data>sample string 1</Data>
</ObjResultOfstring>
bool hasModels = Model.ParameterModels.Count > 0; if (hasModels) {

Parameter Information

data

Property Description
Settings (PDFExportSettings)

				
Ids (Int64[])
            List of Items IDs
            
}