GET PurchaseContract/GetPurchaseContract?CustID={CustID}&Location={Location}&Contract={Contract}&Commodity={Commodity}&ContractStatus={ContractStatus}&ContractType={ContractType}&UseDateEst={UseDateEst}&StartDate={StartDate}&EndDate={EndDate}&BidCriteria={BidCriteria}&ShippingDestination={ShippingDestination}&lastModifiedOnOrAfterUtc={lastModifiedOnOrAfterUtc}&lastModifiedOnOrBeforeUtc={lastModifiedOnOrBeforeUtc}

Returns a list of purchase contract by location and any optional parameters provided.

Request Information

URI Parameters

Name	Description	Type	Additional Information
CustID	CustID used on the purchase contract. (optional)	string	Default value is string.Empty
Location	Location used on the purchase contract. (optional)	string	Default value is string.Empty
Contract	Contract number used on the purchase contract. (optional)	string	Default value is string.Empty
Commodity	Commodity used on the purchase contract. (optional)	string	Default value is string.Empty
ContractStatus	ContractStatus used on the purchase contract. (optional)	string	Default value is string.Empty
ContractType	ContractType used on the purchase contract. (optional)	string	Default value is string.Empty
UseDateEst	UseDateEst to indicate whether or not to filter by the Start and End Dates used on the purchase contract. (optional)	boolean	Default value is False
StartDate	If UseDateRange is true, the StartDate used on the purchase contract. Format MM-dd-yyyy (optional)	string	Default value is string.Empty
EndDate	If UseDateRange is true, EndDate used on the purchase contract. Format MM-dd-yyyy (optional)	string	Default value is string.Empty
BidCriteria	BidCriteria used on the purchase contract. (optional)	string	Default value is string.Empty
ShippingDestination	ShippingDestination used on the purchase contract. (optional)	string	Default value is string.Empty
lastModifiedOnOrAfterUtc	Filter the list of contracts to those changed on or after the supplied UTC date and time (optional) - format = yyyy-MM-ddTHH:mm:ss	string	Default value is string.Empty
lastModifiedOnOrBeforeUtc	Filter the list of contracts to those changed on or before the supplied UTC date and time (optional) format = yyyy-MM-ddTHH:mm:ss	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns a list of purchase contract by location and any optional parameters provided.

AgvPurchaseContractList

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many PurchaseContract JSON dictionaries.	string
PurchaseContractList	JSON dictionary of PurchaseContractListItem.	Collection of PurchaseContractListItem

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "PurchaseContractList": [
    {
      "Contract": "sample string 1",
      "Location": "sample string 2",
      "Commodity": "sample string 3",
      "DateEstablished": "sample string 4",
      "ContractType": "sample string 5",
      "ContractQuantity": "sample string 6",
      "DelStartDate": "sample string 7",
      "DelEndDate": "sample string 8",
      "UniqueID": 9,
      "LastModifiedUtc": "2024-04-27T01:15:41.7364579+00:00"
    },
    {
      "Contract": "sample string 1",
      "Location": "sample string 2",
      "Commodity": "sample string 3",
      "DateEstablished": "sample string 4",
      "ContractType": "sample string 5",
      "ContractQuantity": "sample string 6",
      "DelStartDate": "sample string 7",
      "DelEndDate": "sample string 8",
      "UniqueID": 9,
      "LastModifiedUtc": "2024-04-27T01:15:41.7364579+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvPurchaseContractList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Contract.Purchase">
  <Count>sample string 3</Count>
  <Message>sample string 2</Message>
  <PurchaseContractList>
    <PurchaseContractListItem>
      <Commodity>sample string 3</Commodity>
      <Contract>sample string 1</Contract>
      <ContractQuantity>sample string 6</ContractQuantity>
      <ContractType>sample string 5</ContractType>
      <DateEstablished>sample string 4</DateEstablished>
      <DelEndDate>sample string 8</DelEndDate>
      <DelStartDate>sample string 7</DelStartDate>
      <LastModifiedUtc>2024-04-27T01:15:41.7364579+00:00</LastModifiedUtc>
      <Location>sample string 2</Location>
      <UniqueID>9</UniqueID>
    </PurchaseContractListItem>
    <PurchaseContractListItem>
      <Commodity>sample string 3</Commodity>
      <Contract>sample string 1</Contract>
      <ContractQuantity>sample string 6</ContractQuantity>
      <ContractType>sample string 5</ContractType>
      <DateEstablished>sample string 4</DateEstablished>
      <DelEndDate>sample string 8</DelEndDate>
      <DelStartDate>sample string 7</DelStartDate>
      <LastModifiedUtc>2024-04-27T01:15:41.7364579+00:00</LastModifiedUtc>
      <Location>sample string 2</Location>
      <UniqueID>9</UniqueID>
    </PurchaseContractListItem>
  </PurchaseContractList>
  <Status>sample string 1</Status>
</AgvPurchaseContractList>