GET api/ListMaintenance/GetList/{listReferenceId}
Get full list details for specified list ID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| listReferenceId |
List Id as defined from List Definitions list |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ListItem| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemId |
List Item unique Id |
integer |
None. |
| ClientId |
Client Id |
integer |
None. |
| CompanyId |
Company Id |
integer |
None. |
| CompanyCode |
Company Code: System will fill in this value |
string |
None. |
| ListReferenceId |
List Reference Id: System will fill in this value |
integer |
None. |
| ListType |
List Type: See implementation guide for appropriate values |
string |
None. |
| UserText1 |
User Text 1: Max Characters 100 |
string |
None. |
| UserText2 |
User Text 2: Max Characters 100 |
string |
None. |
| UserText3 |
User Text 3: Max Characters 100 |
string |
None. |
| UserText4 |
User Text 4: Max Characters 100 |
string |
None. |
| UserText5 |
User Text 5: Max Characters 100 |
string |
None. |
| UserText6 |
User Text 6: Max Characters 100 |
string |
None. |
| UserText7 |
User Text 7: Max Characters 100 |
string |
None. |
| UserText8 |
User Text 8: Max Characters 100 |
string |
None. |
| UserText9 |
User Text 9: Max Characters 100 |
string |
None. |
| UserText10 |
User Text 10: Max Characters 100 |
string |
None. |
| UserText11 |
User Text 11: Max Characters 100 |
string |
None. |
| UserText12 |
User Text 12: Max Characters 100 |
string |
None. |
| UserText13 |
User Text 13: Max Characters 100 |
string |
None. |
| UserText14 |
User Text 14: Max Characters 100 |
string |
None. |
| UserText15 |
User Text 15: Max Characters 100 |
string |
None. |
| UserInteger1 |
User Integer 1 |
integer |
None. |
| UserInteger2 |
User Integer 2 |
integer |
None. |
| UserInteger3 |
User Integer 3 |
integer |
None. |
| UserInteger4 |
User Integer 4 |
integer |
None. |
| UserInteger5 |
User Integer 5 |
integer |
None. |
| UserDecimal1 |
User Decimal 1 |
decimal number |
None. |
| UserDecimal2 |
User Decimal 2 |
decimal number |
None. |
| UserDecimal3 |
User Decimal 3 |
decimal number |
None. |
| UserDecimal4 |
User Decimal 4 |
decimal number |
None. |
| UserDecimal5 |
User Decimal 5 |
decimal number |
None. |
| UserDecimal6 |
User Decimal 6 |
decimal number |
None. |
| UserDecimal7 |
User Decimal 7 |
decimal number |
None. |
| UserDecimal8 |
User Decimal 8 |
decimal number |
None. |
| UserDecimal9 |
User Decimal 9 |
decimal number |
None. |
| UserDecimal10 |
User Decimal 10 |
decimal number |
None. |
| UserLargeText |
User Large Text: Max Characters 2,048 |
string |
None. |
Response Formats
application/json, text/json
[
{
"ItemId": 1,
"ClientId": 2,
"CompanyId": 1,
"CompanyCode": "sample string 3",
"ListReferenceId": 1,
"ListType": "sample string 4",
"UserText1": "sample string 5",
"UserText2": "sample string 6",
"UserText3": "sample string 7",
"UserText4": "sample string 8",
"UserText5": "sample string 9",
"UserText6": "sample string 10",
"UserText7": "sample string 11",
"UserText8": "sample string 12",
"UserText9": "sample string 13",
"UserText10": "sample string 14",
"UserText11": "sample string 15",
"UserText12": "sample string 16",
"UserText13": "sample string 17",
"UserText14": "sample string 18",
"UserText15": "sample string 19",
"UserInteger1": 1,
"UserInteger2": 1,
"UserInteger3": 1,
"UserInteger4": 1,
"UserInteger5": 1,
"UserDecimal1": 1.0,
"UserDecimal2": 1.0,
"UserDecimal3": 1.0,
"UserDecimal4": 1.0,
"UserDecimal5": 1.0,
"UserDecimal6": 1.0,
"UserDecimal7": 1.0,
"UserDecimal8": 1.0,
"UserDecimal9": 1.0,
"UserDecimal10": 1.0,
"UserLargeText": "sample string 20"
},
{
"ItemId": 1,
"ClientId": 2,
"CompanyId": 1,
"CompanyCode": "sample string 3",
"ListReferenceId": 1,
"ListType": "sample string 4",
"UserText1": "sample string 5",
"UserText2": "sample string 6",
"UserText3": "sample string 7",
"UserText4": "sample string 8",
"UserText5": "sample string 9",
"UserText6": "sample string 10",
"UserText7": "sample string 11",
"UserText8": "sample string 12",
"UserText9": "sample string 13",
"UserText10": "sample string 14",
"UserText11": "sample string 15",
"UserText12": "sample string 16",
"UserText13": "sample string 17",
"UserText14": "sample string 18",
"UserText15": "sample string 19",
"UserInteger1": 1,
"UserInteger2": 1,
"UserInteger3": 1,
"UserInteger4": 1,
"UserInteger5": 1,
"UserDecimal1": 1.0,
"UserDecimal2": 1.0,
"UserDecimal3": 1.0,
"UserDecimal4": 1.0,
"UserDecimal5": 1.0,
"UserDecimal6": 1.0,
"UserDecimal7": 1.0,
"UserDecimal8": 1.0,
"UserDecimal9": 1.0,
"UserDecimal10": 1.0,
"UserLargeText": "sample string 20"
}
]
application/xml, text/xml
<ArrayOfListMaintenanceController.ListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
<ListMaintenanceController.ListItem>
<ClientId>2</ClientId>
<CompanyCode>sample string 3</CompanyCode>
<CompanyId>1</CompanyId>
<ItemId>1</ItemId>
<ListReferenceId>1</ListReferenceId>
<ListType>sample string 4</ListType>
<UserDecimal1>1</UserDecimal1>
<UserDecimal10>1</UserDecimal10>
<UserDecimal2>1</UserDecimal2>
<UserDecimal3>1</UserDecimal3>
<UserDecimal4>1</UserDecimal4>
<UserDecimal5>1</UserDecimal5>
<UserDecimal6>1</UserDecimal6>
<UserDecimal7>1</UserDecimal7>
<UserDecimal8>1</UserDecimal8>
<UserDecimal9>1</UserDecimal9>
<UserInteger1>1</UserInteger1>
<UserInteger2>1</UserInteger2>
<UserInteger3>1</UserInteger3>
<UserInteger4>1</UserInteger4>
<UserInteger5>1</UserInteger5>
<UserLargeText>sample string 20</UserLargeText>
<UserText1>sample string 5</UserText1>
<UserText10>sample string 14</UserText10>
<UserText11>sample string 15</UserText11>
<UserText12>sample string 16</UserText12>
<UserText13>sample string 17</UserText13>
<UserText14>sample string 18</UserText14>
<UserText15>sample string 19</UserText15>
<UserText2>sample string 6</UserText2>
<UserText3>sample string 7</UserText3>
<UserText4>sample string 8</UserText4>
<UserText5>sample string 9</UserText5>
<UserText6>sample string 10</UserText6>
<UserText7>sample string 11</UserText7>
<UserText8>sample string 12</UserText8>
<UserText9>sample string 13</UserText9>
</ListMaintenanceController.ListItem>
<ListMaintenanceController.ListItem>
<ClientId>2</ClientId>
<CompanyCode>sample string 3</CompanyCode>
<CompanyId>1</CompanyId>
<ItemId>1</ItemId>
<ListReferenceId>1</ListReferenceId>
<ListType>sample string 4</ListType>
<UserDecimal1>1</UserDecimal1>
<UserDecimal10>1</UserDecimal10>
<UserDecimal2>1</UserDecimal2>
<UserDecimal3>1</UserDecimal3>
<UserDecimal4>1</UserDecimal4>
<UserDecimal5>1</UserDecimal5>
<UserDecimal6>1</UserDecimal6>
<UserDecimal7>1</UserDecimal7>
<UserDecimal8>1</UserDecimal8>
<UserDecimal9>1</UserDecimal9>
<UserInteger1>1</UserInteger1>
<UserInteger2>1</UserInteger2>
<UserInteger3>1</UserInteger3>
<UserInteger4>1</UserInteger4>
<UserInteger5>1</UserInteger5>
<UserLargeText>sample string 20</UserLargeText>
<UserText1>sample string 5</UserText1>
<UserText10>sample string 14</UserText10>
<UserText11>sample string 15</UserText11>
<UserText12>sample string 16</UserText12>
<UserText13>sample string 17</UserText13>
<UserText14>sample string 18</UserText14>
<UserText15>sample string 19</UserText15>
<UserText2>sample string 6</UserText2>
<UserText3>sample string 7</UserText3>
<UserText4>sample string 8</UserText4>
<UserText5>sample string 9</UserText5>
<UserText6>sample string 10</UserText6>
<UserText7>sample string 11</UserText7>
<UserText8>sample string 12</UserText8>
<UserText9>sample string 13</UserText9>
</ListMaintenanceController.ListItem>
</ArrayOfListMaintenanceController.ListItem>