GET Obligation/GetNewObligationDocumentForS3?obligationGuid={obligationGuid}

Given an obligation unique identifier, will generate the legacy document and save it in S3 giving back the identifier of that file

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
obligationGuid

The unique identifier of the obligation to generate the legacy document in S3

 globally unique identifier

Required

Body Parameters

Response Information

Resource Description

Given an obligation unique identifier, will generate the legacy document and save it in S3 giving back the identifier of that file

AgvObligationS3
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 errors from the API

 Collection of string
WarningList

List of warnings from the API

 Collection of string
S3FileNameGuid

The unique identifier of the S3 file that was generated for the requested purchase contract

 globally unique identifier

Will be "null" when the status is not success.
PreSignedUrl

The presigned url of the file

 string

Will be "null" when the S3FileNameGuid is not populated.

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"
  ],
  "S3FileNameGuid": "fc5ccc85-2838-4642-8f1b-4d304a717c04",
  "PreSignedUrl": "sample string 3"
}

application/xml, text/xml

Sample: 
<AgvObligationS3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Contract.Obligation">
  <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>
  <PreSignedUrl>sample string 3</PreSignedUrl>
  <S3FileNameGuid>fc5ccc85-2838-4642-8f1b-4d304a717c04</S3FileNameGuid>
  <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>
</AgvObligationS3>