Mds.Api

<back to all web services

DiagramSingle

Requires Authentication
Requires any of the roles:dealer-api-mds, dealer-api-nop
The following routes are available for this service:
All Verbs/diagram-single/{DiagramId}
DiagramSingle Parameters:
NameParameterData TypeRequiredDescription
DiagramIdpathintNo
DiagramSingleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PartsformList<MyobStockItemMapping>No
MyobStockItemMapping Parameters:
NameParameterData TypeRequiredDescription
StockItemIdformintNo
IdformintNo
NumberformintNo
InventoryIdformstringNo
GroupIdformintNo
NameformstringNo
RetailPriceformdecimal?No
DealerPriceformdecimal?No
TradePriceformdecimal?No
RetailPriceNzformdecimal?No
TradePriceNzformdecimal?No
DealerPriceNzformdecimal?No
SalesUomformstringNo
StockingIndicatorformstringNo
ColorformstringNo
ColorCodeformstringNo
NoteTextformstringNo
CoordinatesformList<Coordinate>No
PartQuantityformintNo
AvaiableQuantityformintNo
ShowAvailabilityPopUpformboolNo
IsFdformboolNo
Coordinate Parameters:
NameParameterData TypeRequiredDescription
x1formintNo
y1formintNo
x2formintNo
y2formintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /diagram-single/{DiagramId} HTTP/1.1 
Host: mds-api.mojomotorcycles.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DiagramSingle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mds.Api.ServiceModel">
  <DiagramId>0</DiagramId>
</DiagramSingle>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DiagramSingleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mds.Api.ServiceModel">
  <Parts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tiptopweb.MojoPortal.Shared.Poco">
    <d2p1:MyobStockItemMapping>
      <d2p1:AvaiableQuantity>0</d2p1:AvaiableQuantity>
      <d2p1:Color>String</d2p1:Color>
      <d2p1:ColorCode>String</d2p1:ColorCode>
      <d2p1:Coordinates>
        <d2p1:Coordinate>
          <d2p1:x1>0</d2p1:x1>
          <d2p1:x2>0</d2p1:x2>
          <d2p1:y1>0</d2p1:y1>
          <d2p1:y2>0</d2p1:y2>
        </d2p1:Coordinate>
      </d2p1:Coordinates>
      <d2p1:DealerPrice>0</d2p1:DealerPrice>
      <d2p1:DealerPriceNz>0</d2p1:DealerPriceNz>
      <d2p1:GroupId>0</d2p1:GroupId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:InventoryId>String</d2p1:InventoryId>
      <d2p1:IsFd>false</d2p1:IsFd>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NoteText>String</d2p1:NoteText>
      <d2p1:Number>0</d2p1:Number>
      <d2p1:PartQuantity>0</d2p1:PartQuantity>
      <d2p1:RetailPrice>0</d2p1:RetailPrice>
      <d2p1:RetailPriceNz>0</d2p1:RetailPriceNz>
      <d2p1:SalesUom>String</d2p1:SalesUom>
      <d2p1:ShowAvailabilityPopUp>false</d2p1:ShowAvailabilityPopUp>
      <d2p1:StockItemId>0</d2p1:StockItemId>
      <d2p1:StockingIndicator>String</d2p1:StockingIndicator>
      <d2p1:TradePrice>0</d2p1:TradePrice>
      <d2p1:TradePriceNz>0</d2p1:TradePriceNz>
    </d2p1:MyobStockItemMapping>
  </Parts>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</DiagramSingleResponse>