GET SdsDocument/GetSdsDocument?documentType={documentType}&transactionGuid={transactionGuid}

Returns a dictionary of the product guid and pre-signed url to a pdf for the SDS documents that exist for the products on the given transaction

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
documentType

The document type to generate the SDS documents for

 EnumDocumentType

Required
transactionGuid

The unique identifier of the transaction to create the SDS documents for

 globally unique identifier

Required

Body Parameters

Response Information

Resource Description

Returns a dictionary of the product guid and pre-signed url to a pdf for the SDS documents that exist for the products on the given transaction

AgvSdsDocument
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
Data

A dictionary of the product GUID and its Presigned URL to the SDS document

 Dictionary of globally unique identifier [key] and string [value]

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"
  ],
  "Data": {
    "0828a617-c701-40e9-b8a1-097a29b12626": "sample string 2",
    "b6cf853f-0ffb-4f05-a146-fe707839cd38": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<AgvSdsDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Document">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfguidstring>
      <d2p1:Key>0828a617-c701-40e9-b8a1-097a29b12626</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfguidstring>
    <d2p1:KeyValueOfguidstring>
      <d2p1:Key>b6cf853f-0ffb-4f05-a146-fe707839cd38</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfguidstring>
  </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>
</AgvSdsDocument>