POST BlendTicketDocument/CreateBlendDocuments

Create blend ticket documents for the requested tickets

Request Information

URI Parameters

Body Parameters

Object used to create the documents.

ClsBlendTicketDocumentCreationRequest
NameDescriptionTypeAdditional Information
MergeToSingleFile

Set to merge all of the requested files into a single pdf document

 boolean
Tickets

The list of tickets and document types for which to create pdfs

 Collection of ClsBlendTicketDocumentCreationRequestItem

Required

List cannot be empty

Request Formats

application/json, text/json

Sample: 
{
  "MergeToSingleFile": true,
  "Tickets": [
    {
      "BlendTicketGuid": "1f2f6e3f-4ac8-4430-88a8-1a88b55c0329",
      "IncludeBatchDocument": true,
      "IncludeCustomApplicationDocument": true,
      "IncludeFullPageMap": true,
      "CustomAppFormat": 0,
      "MapZoomLevel": 5,
      "CustomAppPrintSignature": true,
      "MapUsesApplicationZoneWhenPresent": true,
      "FieldGuidsForCustomApplications": [
        "c1d82275-769b-48c2-9a18-e048c839a541",
        "1e9d3eb4-8549-4ddc-9238-4d11ba8ff724"
      ]
    },
    {
      "BlendTicketGuid": "1f2f6e3f-4ac8-4430-88a8-1a88b55c0329",
      "IncludeBatchDocument": true,
      "IncludeCustomApplicationDocument": true,
      "IncludeFullPageMap": true,
      "CustomAppFormat": 0,
      "MapZoomLevel": 5,
      "CustomAppPrintSignature": true,
      "MapUsesApplicationZoneWhenPresent": true,
      "FieldGuidsForCustomApplications": [
        "c1d82275-769b-48c2-9a18-e048c839a541",
        "1e9d3eb4-8549-4ddc-9238-4d11ba8ff724"
      ]
    }
  ]
}

application/xml, text/xml

Sample: 
<ClsBtPrint.ClsBlendTicketDocumentCreationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.plbl">
  <MergeToSingleFile>true</MergeToSingleFile>
  <Tickets>
    <ClsBtPrint.ClsBlendTicketDocumentCreationRequestItem>
      <BlendTicketGuid>1f2f6e3f-4ac8-4430-88a8-1a88b55c0329</BlendTicketGuid>
      <CustomAppFormat>NotSelected</CustomAppFormat>
      <CustomAppPrintSignature>true</CustomAppPrintSignature>
      <FieldGuidsForCustomApplications xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>c1d82275-769b-48c2-9a18-e048c839a541</d4p1:guid>
        <d4p1:guid>1e9d3eb4-8549-4ddc-9238-4d11ba8ff724</d4p1:guid>
      </FieldGuidsForCustomApplications>
      <IncludeBatchDocument>true</IncludeBatchDocument>
      <IncludeCustomApplicationDocument>true</IncludeCustomApplicationDocument>
      <IncludeFullPageMap>true</IncludeFullPageMap>
      <MapUsesApplicationZoneWhenPresent>true</MapUsesApplicationZoneWhenPresent>
      <MapZoomLevel>5</MapZoomLevel>
    </ClsBtPrint.ClsBlendTicketDocumentCreationRequestItem>
    <ClsBtPrint.ClsBlendTicketDocumentCreationRequestItem>
      <BlendTicketGuid>1f2f6e3f-4ac8-4430-88a8-1a88b55c0329</BlendTicketGuid>
      <CustomAppFormat>NotSelected</CustomAppFormat>
      <CustomAppPrintSignature>true</CustomAppPrintSignature>
      <FieldGuidsForCustomApplications xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>c1d82275-769b-48c2-9a18-e048c839a541</d4p1:guid>
        <d4p1:guid>1e9d3eb4-8549-4ddc-9238-4d11ba8ff724</d4p1:guid>
      </FieldGuidsForCustomApplications>
      <IncludeBatchDocument>true</IncludeBatchDocument>
      <IncludeCustomApplicationDocument>true</IncludeCustomApplicationDocument>
      <IncludeFullPageMap>true</IncludeFullPageMap>
      <MapUsesApplicationZoneWhenPresent>true</MapUsesApplicationZoneWhenPresent>
      <MapZoomLevel>5</MapZoomLevel>
    </ClsBtPrint.ClsBlendTicketDocumentCreationRequestItem>
  </Tickets>
</ClsBtPrint.ClsBlendTicketDocumentCreationRequest>

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 'ClsBlendTicketDocumentCreationRequest'.

Response Information

Resource Description

Create blend ticket documents for the requested tickets

AgvBlendTicketDocument
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

 string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

 string
ErrorList

List of error messages of the API call.

 Collection of string
WarningList

List of warning messages of the API call.

 Collection of string
Count

Number of results returned.

 string
Data

List of files created in S3 for the supplied blend ticket(s) request

 ClsBlendTicketDocumentCreationResponse

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "1",
  "Data": {
    "Documents": [
      {
        "S3FileNameGuid": "d3305b94-4f9f-4eea-aaf4-0d32df77219d",
        "BlendTicketGuid": "f518df06-afb5-4a6a-8920-47bcafa89343",
        "DocumentType": "sample string 2",
        "PreSignedUrl": "sample string 3",
        "FieldGuid": "7dfd4e17-c71d-4252-8eae-4acf7a63174b"
      },
      {
        "S3FileNameGuid": "d3305b94-4f9f-4eea-aaf4-0d32df77219d",
        "BlendTicketGuid": "f518df06-afb5-4a6a-8920-47bcafa89343",
        "DocumentType": "sample string 2",
        "PreSignedUrl": "sample string 3",
        "FieldGuid": "7dfd4e17-c71d-4252-8eae-4acf7a63174b"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<AgvBlendTicketDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Blend">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.plbl">
    <d2p1:Documents>
      <d2p1:ClsBtPrint.ClsBlendTicketDocumentItem>
        <d2p1:BlendTicketGuid>f518df06-afb5-4a6a-8920-47bcafa89343</d2p1:BlendTicketGuid>
        <d2p1:DocumentType>sample string 2</d2p1:DocumentType>
        <d2p1:FieldGuid>7dfd4e17-c71d-4252-8eae-4acf7a63174b</d2p1:FieldGuid>
        <d2p1:PreSignedUrl>sample string 3</d2p1:PreSignedUrl>
        <d2p1:S3FileNameGuid>d3305b94-4f9f-4eea-aaf4-0d32df77219d</d2p1:S3FileNameGuid>
      </d2p1:ClsBtPrint.ClsBlendTicketDocumentItem>
      <d2p1:ClsBtPrint.ClsBlendTicketDocumentItem>
        <d2p1:BlendTicketGuid>f518df06-afb5-4a6a-8920-47bcafa89343</d2p1:BlendTicketGuid>
        <d2p1:DocumentType>sample string 2</d2p1:DocumentType>
        <d2p1:FieldGuid>7dfd4e17-c71d-4252-8eae-4acf7a63174b</d2p1:FieldGuid>
        <d2p1:PreSignedUrl>sample string 3</d2p1:PreSignedUrl>
        <d2p1:S3FileNameGuid>d3305b94-4f9f-4eea-aaf4-0d32df77219d</d2p1:S3FileNameGuid>
      </d2p1:ClsBtPrint.ClsBlendTicketDocumentItem>
    </d2p1:Documents>
  </Data>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvBlendTicketDocument>