GET api/ParameterMatch/GetSuggestions?orderId={orderId}&conditionReportId={conditionReportId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderId

string

Required

conditionReportId

string

Required

Body Parameters

None.

Response Information

Resource Description

ParameterMatchApiResponse
NameDescriptionTypeAdditional information
lines

Collection of SuggestedOrderLine

None.

orderId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "lines": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "description": "sample string 3",
      "productId": "sample string 4",
      "guid": "9ba140cd-dc5d-4e60-a116-0f613b4113b7",
      "quantity": 6.0,
      "amount": 7.0,
      "unit": {
        "id": "7edcd69b-688c-44ec-aaab-67d40441662e",
        "logicalName": "sample string 2"
      },
      "task": {
        "createTask": true,
        "subject": "sample string 2",
        "description": "sample string 3"
      },
      "isPreApproved": true,
      "refParameterId": "91c61cf4-ceca-42f2-be19-48a00719028e",
      "isTaskOnly": true,
      "hasAmount": true
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "description": "sample string 3",
      "productId": "sample string 4",
      "guid": "9ba140cd-dc5d-4e60-a116-0f613b4113b7",
      "quantity": 6.0,
      "amount": 7.0,
      "unit": {
        "id": "7edcd69b-688c-44ec-aaab-67d40441662e",
        "logicalName": "sample string 2"
      },
      "task": {
        "createTask": true,
        "subject": "sample string 2",
        "description": "sample string 3"
      },
      "isPreApproved": true,
      "refParameterId": "91c61cf4-ceca-42f2-be19-48a00719028e",
      "isTaskOnly": true,
      "hasAmount": true
    }
  ],
  "orderId": "10a6cf7a-3289-4ce9-b8e8-461931406fec"
}

application/xml, text/xml

Sample:
<ParameterMatchApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PARS.WebApi.Proxy.Models">
  <Lines xmlns:d2p1="http://schemas.datacontract.org/2004/07/PARS.Web.Common.Model">
    <d2p1:SuggestedOrderLine>
      <d2p1:Amount>7</d2p1:Amount>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:HasAmount>true</d2p1:HasAmount>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsPreApproved>true</d2p1:IsPreApproved>
      <d2p1:IsTaskOnly>true</d2p1:IsTaskOnly>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:ProductGuid>9ba140cd-dc5d-4e60-a116-0f613b4113b7</d2p1:ProductGuid>
      <d2p1:ProductId>sample string 4</d2p1:ProductId>
      <d2p1:Quantity>6</d2p1:Quantity>
      <d2p1:ReferenceParameterId>91c61cf4-ceca-42f2-be19-48a00719028e</d2p1:ReferenceParameterId>
      <d2p1:Task>
        <d2p1:CreateTask>true</d2p1:CreateTask>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:Subject>sample string 2</d2p1:Subject>
      </d2p1:Task>
      <d2p1:Unit>
        <Id>7edcd69b-688c-44ec-aaab-67d40441662e</Id>
        <LogicalName>sample string 2</LogicalName>
      </d2p1:Unit>
    </d2p1:SuggestedOrderLine>
    <d2p1:SuggestedOrderLine>
      <d2p1:Amount>7</d2p1:Amount>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:HasAmount>true</d2p1:HasAmount>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsPreApproved>true</d2p1:IsPreApproved>
      <d2p1:IsTaskOnly>true</d2p1:IsTaskOnly>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:ProductGuid>9ba140cd-dc5d-4e60-a116-0f613b4113b7</d2p1:ProductGuid>
      <d2p1:ProductId>sample string 4</d2p1:ProductId>
      <d2p1:Quantity>6</d2p1:Quantity>
      <d2p1:ReferenceParameterId>91c61cf4-ceca-42f2-be19-48a00719028e</d2p1:ReferenceParameterId>
      <d2p1:Task>
        <d2p1:CreateTask>true</d2p1:CreateTask>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:Subject>sample string 2</d2p1:Subject>
      </d2p1:Task>
      <d2p1:Unit>
        <Id>7edcd69b-688c-44ec-aaab-67d40441662e</Id>
        <LogicalName>sample string 2</LogicalName>
      </d2p1:Unit>
    </d2p1:SuggestedOrderLine>
  </Lines>
  <OrderId>10a6cf7a-3289-4ce9-b8e8-461931406fec</OrderId>
</ParameterMatchApiResponse>