GET v1/CustomerContracts/{customerContractId}/Parameters

Get all CustomerContract Parameters.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerContractId

The id of the CustomerContract.

integer

Required.

Body Parameters

None.

Response Information

Resource Description

A collection of CustomerContract Parameters.

Collection of Parameter
NameDescriptionTypeAdditional information
Key

Gets or sets the key.

string

None.

Value

Gets or sets the value.

string

None.

DataType

Specify the data type. Default type is String.

KeyValueParameterDataType

None.

DataTypeName

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Key": "sample string 1",
    "Value": "sample string 2",
    "DataType": 0,
    "DataTypeName": "String"
  },
  {
    "Key": "sample string 1",
    "Value": "sample string 2",
    "DataType": 0,
    "DataTypeName": "String"
  }
]

application/xml, text/xml

Sample:
<ArrayOfParameter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Parameter>
    <Key>sample string 1</Key>
    <Value>sample string 2</Value>
    <DataType>String</DataType>
  </Parameter>
  <Parameter>
    <Key>sample string 1</Key>
    <Value>sample string 2</Value>
    <DataType>String</DataType>
  </Parameter>
</ArrayOfParameter>