CollectionsAPI

GetCollectionsRequest

The following routes are available for this service:
GET	/v4/collections/list

**V4ListRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Ids	form	List<string>	No

**V4PaginatedBaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	form	int	No
Limit	form	int	No

**GetCollectionsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	IEnumerable<IUserCollection>	No

**V4PaginatedBaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Page	form	V4PageObject	No

**V4BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**V4PageObject** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Limit	form	int	No
TotalRecords	form	int	No

**IUserCollection** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Title	form	string	No
LinkIds	form	IEnumerable<string>	No
CollectionSettingsId	form	string	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.

GET /v4/collections/list HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml

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

<GetCollectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Responses">
  <status xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </status>
  <page>
    <limit>0</limit>
    <offset>0</offset>
    <totalRecords>0</totalRecords>
  </page>
  <data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</GetCollectionsResponse>