GET HazmatDocument/GetHazmatDocument?documentType={documentType}&transactionGuid={transactionGuid}&printOneHazmatPerBatch={printOneHazmatPerBatch}

Returns a list pre-signed urls to pdfs of Hazmat documents for the given transaction

Request Information

URI Parameters

Name	Description	Type	Additional Information
documentType	The document type to generate the Hazmat document for. 1 for delivery tickets. 4 for Blend Tickets	EnumDocumentType	Required
transactionGuid	The unique identifier of the transaction to create the Hazmat document for	globally unique identifier	Required
printOneHazmatPerBatch	Blend Tickets Only.	boolean	Default value is False

Body Parameters

Response Information

Resource Description

Returns a list pre-signed urls to pdfs of Hazmat documents for the given transaction

AgvHazmatDocument

Name	Description	Type	Additional 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	Count of how many PreSignedUrls	string
PreSignedUrls	The presigned urls of the files	Collection of string	Will be "null" when the status is not success.

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": "2",
  "PreSignedUrls": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<AgvHazmatDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Document">
  <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>
  <PreSignedUrls xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PreSignedUrls>
  <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>
</AgvHazmatDocument>