GET api/OmsShipmentMethodRule?isActive={isActive}

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
isActive

boolean

None.

Body Parameters

None.

Response Information

Resource Description

ShipmentMethodRuleResponse

NameDescriptionTypeAdditional Information
Rules

Collection of IShipmentMethodRule

None.

ValidationErrors

Dictionary of string [key] and string [value]

None.

DeletedRecords

integer

None.

ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ValidationErrors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "DeletedRecords": 1,
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:
<ShipmentMethodRuleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 2</CorrelationId>
  <DeletedRecords>1</DeletedRecords>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
  <Rules xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ValidationErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ValidationErrors>
</ShipmentMethodRuleResponse>