POST V1/Inventory.{ext}/VendorContractSearch

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ext

Which media types are acceptable for the response, such as json/xml

If no matches are found, the content negotiator tries to match on the media type of the request body, if any. For example, if the request contains JSON data, the content negotiator looks for a JSON formatter.

string

Content-Type: application/json OR application/xml

Body Parameters

EMS.Inventory.Entities.VendorContracts
NameDescriptionTypeAdditional information
VendorContractId

No description available

string

None.

VendorId

No description available

string

None.

VendorName

No description available

string

None.

ContractAgreementNumber

No description available

string

None.

ContractTypeId

No description available

string

None.

ContractTypeName

No description available

string

None.

ContractProductId

No description available

string

None.

ContractProductName

No description available

string

None.

EffectivePeriodFrom

No description available

string

None.

EffectivePeriodTo

No description available

string

None.

FileName

No description available

string

None.

ContractStatus

No description available

string

None.

Commodity

No description available

string

None.

CreatedBy

No description available

string

None.

CreatedDate

No description available

string

None.

EffectivePeriod

No description available

string

None.

MSANumber

No description available

string

None.

UploadedFrom

No description available

string

None.

UploadedTo

No description available

string

None.

IsFileExist

No description available

string

None.

Tags

No description available

string

None.

SiteNbr

No description available

string

None.

SiteId

No description available

string

None.

TagName

No description available

string

None.

AccountID

No description available

string

None.

AccountNumber

No description available

string

None.

Rate

No description available

string

None.

Supplier

No description available

string

None.

Billing

No description available

string

None.

Notify

No description available

string

None.

ContractTerm

No description available

string

None.

Request Formats

application/json, text/json

Sample:
{
  "vendorContractId": "sample string 1",
  "vendorId": "sample string 2",
  "vendorName": "sample string 3",
  "contractAgreementNumber": "sample string 4",
  "contractTypeId": "sample string 5",
  "contractTypeName": "sample string 6",
  "contractProductId": "sample string 7",
  "contractProductName": "sample string 8",
  "effectivePeriodFrom": "sample string 9",
  "effectivePeriodTo": "sample string 10",
  "fileName": "sample string 11",
  "contractStatus": "sample string 12",
  "commodity": "sample string 13",
  "createdBy": "sample string 14",
  "createdDate": "sample string 15",
  "effectivePeriod": "sample string 16",
  "msaNumber": "sample string 17",
  "uploadedFrom": "sample string 18",
  "uploadedTo": "sample string 19",
  "isFileExist": "sample string 20",
  "tags": "sample string 21",
  "siteNbr": "sample string 22",
  "siteId": "sample string 23",
  "tagName": "sample string 24",
  "accountID": "sample string 25",
  "accountNumber": "sample string 26",
  "rate": "sample string 27",
  "supplier": "sample string 28",
  "billing": "sample string 29",
  "notify": "sample string 30",
  "contractTerm": "sample string 31"
}

application/xml, text/xml

Sample:
<VendorContracts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMS.Inventory.Entities">
  <AccountID>sample string 25</AccountID>
  <AccountNumber>sample string 26</AccountNumber>
  <Billing>sample string 29</Billing>
  <Commodity>sample string 13</Commodity>
  <ContractAgreementNumber>sample string 4</ContractAgreementNumber>
  <ContractProductId>sample string 7</ContractProductId>
  <ContractProductName>sample string 8</ContractProductName>
  <ContractStatus>sample string 12</ContractStatus>
  <ContractTerm>sample string 31</ContractTerm>
  <ContractTypeId>sample string 5</ContractTypeId>
  <ContractTypeName>sample string 6</ContractTypeName>
  <CreatedBy>sample string 14</CreatedBy>
  <CreatedDate>sample string 15</CreatedDate>
  <EffectivePeriod>sample string 16</EffectivePeriod>
  <EffectivePeriodFrom>sample string 9</EffectivePeriodFrom>
  <EffectivePeriodTo>sample string 10</EffectivePeriodTo>
  <FileName>sample string 11</FileName>
  <IsFileExist>sample string 20</IsFileExist>
  <MSANumber>sample string 17</MSANumber>
  <Notify>sample string 30</Notify>
  <Rate>sample string 27</Rate>
  <SiteId>sample string 23</SiteId>
  <SiteNbr>sample string 22</SiteNbr>
  <Supplier>sample string 28</Supplier>
  <TagName>sample string 24</TagName>
  <Tags>sample string 21</Tags>
  <UploadedFrom>sample string 18</UploadedFrom>
  <UploadedTo>sample string 19</UploadedTo>
  <VendorContractId>sample string 1</VendorContractId>
  <VendorId>sample string 2</VendorId>
  <VendorName>sample string 3</VendorName>
</VendorContracts>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

EMSResponseOfEMS.Inventory.Entities.VendorContractList
NameDescriptionTypeAdditional information
ResponseType

No description available

string

None.

Response

No description available

EMS.Inventory.Entities.VendorContractList

None.

Error

No description available

EMS.Common.Error

None.

Response Formats

application/json, text/json

Sample:
{
  "responseType": "VendorContractList",
  "response": {
    "vendorContractsList": [
      {
        "vendorContractId": "sample string 1",
        "vendorId": "sample string 2",
        "vendorName": "sample string 3",
        "contractAgreementNumber": "sample string 4",
        "contractTypeId": "sample string 5",
        "contractTypeName": "sample string 6",
        "contractProductId": "sample string 7",
        "contractProductName": "sample string 8",
        "effectivePeriodFrom": "sample string 9",
        "effectivePeriodTo": "sample string 10",
        "fileName": "sample string 11",
        "contractStatus": "sample string 12",
        "commodity": "sample string 13",
        "createdBy": "sample string 14",
        "createdDate": "sample string 15",
        "effectivePeriod": "sample string 16",
        "msaNumber": "sample string 17",
        "uploadedFrom": "sample string 18",
        "uploadedTo": "sample string 19",
        "isFileExist": "sample string 20",
        "tags": "sample string 21",
        "siteNbr": "sample string 22",
        "siteId": "sample string 23",
        "tagName": "sample string 24",
        "accountID": "sample string 25",
        "accountNumber": "sample string 26",
        "rate": "sample string 27",
        "supplier": "sample string 28",
        "billing": "sample string 29",
        "notify": "sample string 30",
        "contractTerm": "sample string 31"
      },
      {
        "vendorContractId": "sample string 1",
        "vendorId": "sample string 2",
        "vendorName": "sample string 3",
        "contractAgreementNumber": "sample string 4",
        "contractTypeId": "sample string 5",
        "contractTypeName": "sample string 6",
        "contractProductId": "sample string 7",
        "contractProductName": "sample string 8",
        "effectivePeriodFrom": "sample string 9",
        "effectivePeriodTo": "sample string 10",
        "fileName": "sample string 11",
        "contractStatus": "sample string 12",
        "commodity": "sample string 13",
        "createdBy": "sample string 14",
        "createdDate": "sample string 15",
        "effectivePeriod": "sample string 16",
        "msaNumber": "sample string 17",
        "uploadedFrom": "sample string 18",
        "uploadedTo": "sample string 19",
        "isFileExist": "sample string 20",
        "tags": "sample string 21",
        "siteNbr": "sample string 22",
        "siteId": "sample string 23",
        "tagName": "sample string 24",
        "accountID": "sample string 25",
        "accountNumber": "sample string 26",
        "rate": "sample string 27",
        "supplier": "sample string 28",
        "billing": "sample string 29",
        "notify": "sample string 30",
        "contractTerm": "sample string 31"
      }
    ]
  },
  "error": {
    "errorCode": "sample string 1",
    "errorDescription": "sample string 2"
  }
}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.