POST PurchaseAndSale/ReversePurchaseAndSale

Reverse a purchase and sale transaction

Request Information

URI Parameters

Body Parameters

A request object containing Location and Transaction Number of a purchase and sale document

Name	Description	Type	Additional Information
Location	The Location of the Purchase and Sale Transaction	string	Required
TransactionNumber	The Transaction Number of the Purchase and Sale Transaction	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "Location": "sample string 1",
  "TransactionNumber": 2
}

application/xml, text/xml

Sample:

<ClsGrPurAndSaleTran.ClsGrPurAndSaleTranReverse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <Location>sample string 1</Location>
  <TransactionNumber>2</TransactionNumber>
</ClsGrPurAndSaleTran.ClsGrPurAndSaleTranReverse>

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

Response Information

Resource Description

Reverse a purchase and sale transaction

AgvPurchaseAndSale

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 errors from the API	Collection of string
WarningList	List of warnings from the API	Collection of string
GrPurAndSaleTranKey		integer
TranNum		string
Location		string
PreSignedUrl	Url of the document created	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"
  ],
  "GrPurAndSaleTranKey": 3,
  "TranNum": "sample string 4",
  "Location": "sample string 5",
  "PreSignedUrl": "sample string 6"
}

application/xml, text/xml

Sample:

<AgvPurchaseAndSale xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.PurchaseAndSale">
  <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>
  <GrPurAndSaleTranKey>3</GrPurAndSaleTranKey>
  <Location>sample string 5</Location>
  <Message>sample string 2</Message>
  <PreSignedUrl>sample string 6</PreSignedUrl>
  <Status>sample string 1</Status>
  <TranNum>sample string 4</TranNum>
  <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>
</AgvPurchaseAndSale>