POST api/PreferredList/GetAllVendors

Request Information

URI Parameters

None.

Body Parameters

VendorListRequestModel
NameDescriptionTypeAdditional information
SSOId

string

None.

SearchTxt

string

None.

CompanyName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SSOId": "sample string 1",
  "SearchTxt": "sample string 2",
  "CompanyName": "sample string 3"
}

application/xml, text/xml

Sample:
<VendorListRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <CompanyName>sample string 3</CompanyName>
  <SSOId>sample string 1</SSOId>
  <SearchTxt>sample string 2</SearchTxt>
</VendorListRequestModel>

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

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SSOId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SearchTxt"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CompanyName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ServiceResponseOfListOfVendorListViewModel
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Message

string

None.

StatusCode

integer

None.

Data

Collection of VendorListViewModel

None.

Exception

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Message": "sample string 2",
  "StatusCode": 3,
  "Data": [
    {
      "VendorCode": 1,
      "VendorTypeCode": 1,
      "VendorType": "sample string 2",
      "SSOID": "sample string 3",
      "VendorName": "sample string 4",
      "ComapnyName": "sample string 5",
      "CompanyAddress": "sample string 6",
      "Email": "sample string 7",
      "Mobile1": "sample string 8"
    },
    {
      "VendorCode": 1,
      "VendorTypeCode": 1,
      "VendorType": "sample string 2",
      "SSOID": "sample string 3",
      "VendorName": "sample string 4",
      "ComapnyName": "sample string 5",
      "CompanyAddress": "sample string 6",
      "Email": "sample string 7",
      "Mobile1": "sample string 8"
    }
  ],
  "Exception": "sample string 4"
}

application/xml, text/xml

Sample:
<ServiceResponseOfArrayOfVendorListViewModelMTRdQN6P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2G.Services.ServiceHelper">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/">
    <d2p1:VendorListViewModel>
      <d2p1:ComapnyName>sample string 5</d2p1:ComapnyName>
      <d2p1:CompanyAddress>sample string 6</d2p1:CompanyAddress>
      <d2p1:Email>sample string 7</d2p1:Email>
      <d2p1:Mobile1>sample string 8</d2p1:Mobile1>
      <d2p1:SSOID>sample string 3</d2p1:SSOID>
      <d2p1:VendorCode>1</d2p1:VendorCode>
      <d2p1:VendorName>sample string 4</d2p1:VendorName>
      <d2p1:VendorType>sample string 2</d2p1:VendorType>
      <d2p1:VendorTypeCode>1</d2p1:VendorTypeCode>
    </d2p1:VendorListViewModel>
    <d2p1:VendorListViewModel>
      <d2p1:ComapnyName>sample string 5</d2p1:ComapnyName>
      <d2p1:CompanyAddress>sample string 6</d2p1:CompanyAddress>
      <d2p1:Email>sample string 7</d2p1:Email>
      <d2p1:Mobile1>sample string 8</d2p1:Mobile1>
      <d2p1:SSOID>sample string 3</d2p1:SSOID>
      <d2p1:VendorCode>1</d2p1:VendorCode>
      <d2p1:VendorName>sample string 4</d2p1:VendorName>
      <d2p1:VendorType>sample string 2</d2p1:VendorType>
      <d2p1:VendorTypeCode>1</d2p1:VendorTypeCode>
    </d2p1:VendorListViewModel>
  </Data>
  <Exception>sample string 4</Exception>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
  <StatusCode>3</StatusCode>
</ServiceResponseOfArrayOfVendorListViewModelMTRdQN6P>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsSuccess"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StatusCode"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].VendorCode"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].VendorTypeCode"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].VendorType"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].SSOID"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].VendorName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].ComapnyName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].CompanyAddress"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Email"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Mobile1"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].VendorCode"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].VendorTypeCode"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].VendorType"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].SSOID"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].VendorName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].ComapnyName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].CompanyAddress"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Email"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Mobile1"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Exception"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--