Internal API-Guide

GET api/Pricing/TradeRateContext?vendorId={vendorId}&clientId={clientId}&locationId={locationId}&tradeId={tradeId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
vendorId

integer

Required
clientId

integer

Required
locationId

integer

Required
tradeId

integer

Required

Body Parameters

None

Response Information

Resource Description

Collection of RateTypeKindOptionCardRequestDTO
NameDescriptionTypeAdditional information
RateCardId

integer None.
RateCardName

string None.
Rate

decimal number None.
RateIsLocked

boolean None.
RateTypeId

integer None.
RateTypeName

string None.
LineItemTypeId

integer None.
RateKindId

integer None.
RateKindName

string None.
RateOptionID

integer None.
RateOptionName

string None.
RequestTypeId

integer None.
RequestCodeId

integer None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "rateCardId": 1,
    "rateCardName": "sample string 2",
    "rate": 3.0,
    "rateIsLocked": true,
    "rateTypeId": 5,
    "rateTypeName": "sample string 6",
    "lineItemTypeId": 7,
    "rateKindId": 8,
    "rateKindName": "sample string 9",
    "rateOptionID": 1,
    "rateOptionName": "sample string 10",
    "requestTypeId": 1,
    "requestCodeId": 1
  },
  {
    "rateCardId": 1,
    "rateCardName": "sample string 2",
    "rate": 3.0,
    "rateIsLocked": true,
    "rateTypeId": 5,
    "rateTypeName": "sample string 6",
    "lineItemTypeId": 7,
    "rateKindId": 8,
    "rateKindName": "sample string 9",
    "rateOptionID": 1,
    "rateOptionName": "sample string 10",
    "requestTypeId": 1,
    "requestCodeId": 1
  }
]

application/xml, text/xml

Sample: 
<ArrayOfRateTypeKindOptionCardRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.Entities.PricingEngine">
  <RateTypeKindOptionCardRequestDTO>
    <CustomFieldXML>sample string 11</CustomFieldXML>
    <LineItemTypeId>7</LineItemTypeId>
    <Rate>3</Rate>
    <RateCardId>1</RateCardId>
    <RateCardName>sample string 2</RateCardName>
    <RateIsLocked>true</RateIsLocked>
    <RateKindId>8</RateKindId>
    <RateKindName>sample string 9</RateKindName>
    <RateOptionID>1</RateOptionID>
    <RateOptionName>sample string 10</RateOptionName>
    <RateTypeId>5</RateTypeId>
    <RateTypeName>sample string 6</RateTypeName>
    <RequestCodeId>1</RequestCodeId>
    <RequestTypeId>1</RequestTypeId>
  </RateTypeKindOptionCardRequestDTO>
  <RateTypeKindOptionCardRequestDTO>
    <CustomFieldXML>sample string 11</CustomFieldXML>
    <LineItemTypeId>7</LineItemTypeId>
    <Rate>3</Rate>
    <RateCardId>1</RateCardId>
    <RateCardName>sample string 2</RateCardName>
    <RateIsLocked>true</RateIsLocked>
    <RateKindId>8</RateKindId>
    <RateKindName>sample string 9</RateKindName>
    <RateOptionID>1</RateOptionID>
    <RateOptionName>sample string 10</RateOptionName>
    <RateTypeId>5</RateTypeId>
    <RateTypeName>sample string 6</RateTypeName>
    <RequestCodeId>1</RequestCodeId>
    <RequestTypeId>1</RequestTypeId>
  </RateTypeKindOptionCardRequestDTO>
</ArrayOfRateTypeKindOptionCardRequestDTO>