POST api/ContractLineSearch/FindContractLines

Get one or more contract lines. Note that the user represented by the TicketId may set implicit restrictions on the search. A PartnerUser for example will typically have restrictions on which contracts he/she can access.

Request Information

URI Parameters

None.

Body Parameters

Specifies search criteria and returned fields

ContractLineSearchArgumentModel
NameDescriptionTypeAdditional information
Criteria

Gets or sets the criteria.

 ContractLineSearchFilter

None.
TicketId

Gets or sets the ticket id

 string

None.
Culture

Gets or sets culture, if not specified we will use culture set on user.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Criteria": {
    "CombinedContractId": [
      "sample string 1",
      "sample string 2"
    ],
    "ContractLineNumber": "sample string 1",
    "ContractName": "sample string 2",
    "Customer": {
      "CustomerId1": 1,
      "CustomerId2": 2,
      "Name": "sample string 3",
      "Address": "sample string 4",
      "AdditionalInfo": "sample string 5",
      "PhoneNumber": "sample string 6",
      "ZipCode": {
        "From": "sample string 1",
        "To": "sample string 2"
      },
      "City": "sample string 7"
    },
    "Product": {
      "ProductId": "sample string 1",
      "Name": "sample string 2",
      "Brand": "sample string 3",
      "SerialNumber": "sample string 4",
      "SerialNumberOut": "sample string 5",
      "SerialNumberCustomer": "sample string 6"
    }
  },
  "TicketId": "sample string 1",
  "Culture": "sample string 2"
}

application/xml, text/xml

Sample: 
<ContractLineSearchController.ContractLineSearchArgumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Controllers">
  <Culture xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 2</Culture>
  <TicketId xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 1</TicketId>
  <Criteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/Rostov.Models">
    <d2p1:CombinedContractId xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:CombinedContractId>
    <d2p1:ContractLineNumber>sample string 1</d2p1:ContractLineNumber>
    <d2p1:ContractName>sample string 2</d2p1:ContractName>
    <d2p1:Customer>
      <d2p1:AdditionalInfo>sample string 5</d2p1:AdditionalInfo>
      <d2p1:Address>sample string 4</d2p1:Address>
      <d2p1:City>sample string 7</d2p1:City>
      <d2p1:CustomerId1>1</d2p1:CustomerId1>
      <d2p1:CustomerId2>2</d2p1:CustomerId2>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:PhoneNumber>sample string 6</d2p1:PhoneNumber>
      <d2p1:ZipCode>
        <d2p1:From>sample string 1</d2p1:From>
        <d2p1:To>sample string 2</d2p1:To>
      </d2p1:ZipCode>
    </d2p1:Customer>
    <d2p1:Product>
      <d2p1:Brand>sample string 3</d2p1:Brand>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:ProductId>sample string 1</d2p1:ProductId>
      <d2p1:SerialNumber>sample string 4</d2p1:SerialNumber>
      <d2p1:SerialNumberCustomer>sample string 6</d2p1:SerialNumberCustomer>
      <d2p1:SerialNumberOut>sample string 5</d2p1:SerialNumberOut>
    </d2p1:Product>
  </Criteria>
</ContractLineSearchController.ContractLineSearchArgumentModel>

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

Response Information

Resource Description

A list of contract line objects, the fields in the returned object will depend upon the fields specified in the search argument

ContractLineSearchReturnModel
NameDescriptionTypeAdditional information
ContractLines

Gets the list of activities returned from a search

 Collection of Object

None.
CombinedPerformanceId

Gets or sets the performance id. If performance monitoring is not turned on this property will not be present or set to null

 string

Json null value handling: Ignore

Response Formats

application/json, text/json

Sample: 
{
  "ContractLines": [
    {},
    {}
  ],
  "CombinedPerformanceId": "sample string 1"
}

application/xml, text/xml

Sample: 
<ContractLineSearchController.ContractLineSearchReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Controllers">
  <CombinedPerformanceId xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">sample string 1</CombinedPerformanceId>
  <ContractLines xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </ContractLines>
</ContractLineSearchController.ContractLineSearchReturnModel>