Coruson API

GetListItems

Coruson Custom Lists

The following routes are available for this service:
GET	/api/lists/items	Query for Coruson List items

**GetListItems** Parameters:
Name	Parameter	Data Type	Required	Description
ListItemId	query	Guid	No	Filter by ListItemId.
Name	query	String	No	Filter by the name of the List Item.
Description	query	String	No	Filter by the description of the List Item.
Code	query	String	No	Filter by the code of the List Item.
ParentId	query	Guid	No	Filter by the parent ListItemId of the List Item.
ParentName	query	String	No	Filter by the name of the parent the List Item(s) belongs to.
FullHierarchy	query	String	No	Filter list items by providing their full hierarchy. Format should be: {Root}\\\\..\\\\..\\\\{Parent}.
ListId	query	Guid	No	Filter by the ListId the List Item(s) belong to.
List	query	String	No	Filter by the name of the List the List Item(s) belong to.
IsActive	query	BooleanFilter	Yes	Filter by the status of the List Item. Allowable Values All True False
OrderBy	query	ListItemOrder	Yes	Property to order by in Ascending order. Default is 'List'. Allowable Values Default Name List ParentName
OrderByDesc	query	ListItemOrder	Yes	Property to order by in Descending order. Allowable Values Default Name List ParentName
ThenBy	query	ListItemOrder	Yes	Second Property to order by in Ascending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored. Allowable Values Default Name List ParentName
ThenByDesc	query	ListItemOrder	Yes	Second Property to order by in Descending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored. Allowable Values Default Name List ParentName

**PagingRequestBase<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	form	Integer	No	Number of items to skip before returning results. Minimum suitable value is 0 and is also the default value.
Take	form	Integer	No	Number of items to return per page. Must be a number in the range 1-100. Default value is 100.
OrderBy	form	Enum	No	Order By
OrderByDesc	form	Enum	No	Order By Descending
ThenBy	form	Enum	No	Then By
ThenByDesc	form	Enum	No	Then By Descending

**RequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	int	No

**GetListItemsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ListItems	form	List<ListItem>	No

**GetResponseBase** Parameters:
Name	Parameter	Data Type	Required
TotalResults	form	int	No
Skip	form	int	No
Take	form	int	No
Links	form	List<Link>	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
StatusDescription	form	string	No
ResponseStatus	form	ResponseStatus	No

**Link** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
RequestUrl	form	string	No
Method	form	string	No

**ListItem** Parameters:
Name	Parameter	Data Type	Required
ListItemId	form	Guid	No
Name	form	string	No
Description	form	string	No
Code	form	string	No
ParentId	form	Guid?	No
ParentName	form	string	No
FullHierarchy	form	string	No
ListId	form	Guid	No
List	form	string	No
IsActive	form	bool	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

                    POST /xml/reply/GetListItems HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: application/xml
Content-Length: length

<GetListItems xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <Skip>0</Skip>
  <Take>0</Take>
  <OrderBy>Default</OrderBy>
  <OrderByDesc>Default</OrderByDesc>
  <ThenBy>Default</ThenBy>
  <ThenByDesc>Default</ThenByDesc>
  <ListItemId>00000000-0000-0000-0000-000000000000</ListItemId>
  <Name>String</Name>
  <Description>String</Description>
  <Code>String</Code>
  <ParentId>00000000-0000-0000-0000-000000000000</ParentId>
  <ParentName>String</ParentName>
  <FullHierarchy>String</FullHierarchy>
  <ListId>00000000-0000-0000-0000-000000000000</ListId>
  <List>String</List>
  <IsActive>All</IsActive>
</GetListItems>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetListItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <StatusDescription>String</StatusDescription>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <TotalResults>0</TotalResults>
  <Skip>0</Skip>
  <Take>0</Take>
  <Links>
    <Link>
      <Name>String</Name>
      <RequestUrl>String</RequestUrl>
      <Method>String</Method>
    </Link>
  </Links>
  <ListItems>
    <ListItem>
      <ListItemId>00000000-0000-0000-0000-000000000000</ListItemId>
      <Name>String</Name>
      <Description>String</Description>
      <Code>String</Code>
      <ParentId>00000000-0000-0000-0000-000000000000</ParentId>
      <ParentName>String</ParentName>
      <FullHierarchy>String</FullHierarchy>
      <ListId>00000000-0000-0000-0000-000000000000</ListId>
      <List>String</List>
      <IsActive>false</IsActive>
    </ListItem>
  </ListItems>
</GetListItemsResponse>

Coruson API

GetListItems

Coruson Custom Lists

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + XML