GET api/collections/{collection}/collectionitems

Get all collection items in a collection.

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
collection

Value of CollectionIdEnum corresonding to the desired collection

 CollectionIdEnum

Required

Body Parameters

None.

Response Information

Resource Description

A list of collection items, if collection enum value is invalid, a resource not found error code will be returned

ListWrapperOfCollectionItem
NameDescriptionTypeAdditional information
Total

integer

None.
Elements

Collection of CollectionItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "Total": 1,
  "Elements": [
    {
      "DisplayName": "sample string 1",
      "Value": "sample string 2",
      "SortOrder": 1
    },
    {
      "DisplayName": "sample string 1",
      "Value": "sample string 2",
      "SortOrder": 1
    }
  ]
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)