GET PurchaseContract/GetNewPurchaseContractAmendmentDocumentForS3?purchaseContractGuid={purchaseContractGuid}&amendmentNumber={amendmentNumber}

Given a purchase contract unique identifier and amendment, will generate the legacy contract and save it in S3 giving back the identifier of that file

Request Information

URI Parameters

Name	Description	Type	Additional Information
purchaseContractGuid	The unique identifier of the purchase contact to generate the legacy document in S3	globally unique identifier	Required
amendmentNumber	Amendment Number of the Purchase Contract Amdendment to generate the legacy document in S3. Enter 0 to return all of Customer's Tanks.	integer	Required

Body Parameters

Response Information

Resource Description

Given a purchase contract unique identifier and amendment, will generate the legacy contract and save it in S3 giving back the identifier of that file

AgvPurchaseContractS3

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

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "S3FileNameGuid": "5e00b529-381b-4e9b-9387-df127b5a3764"
}

application/xml, text/xml

Sample:

<AgvPurchaseContractS3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Contract.Purchase">
  <Message>sample string 2</Message>
  <S3FileNameGuid>5e00b529-381b-4e9b-9387-df127b5a3764</S3FileNameGuid>
  <Status>sample string 1</Status>
</AgvPurchaseContractS3>