CollectionsAPI

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v4/collections
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CollectionsAPI.ServiceModel.V4.Requests;
using CollectionsAPI.ServiceModel.V4.Responses;
using CollectionsAPI.Contracts.V4.Responses;

namespace CollectionsAPI.Contracts.V4.Responses
{
    public partial interface IPostCollectionResponseData
    {
        string Id { get; set; }
    }

}

namespace CollectionsAPI.ServiceModel.V4.Requests
{
    [DataContract]
    public partial class PostCollectionRequest
        : V4BaseRequest, IPostCollectionRequest
    {
        [DataMember(Name="title")]
        public virtual string Title { get; set; }

        [DataMember(Name="linkIds")]
        public virtual IEnumerable<string> LinkIds { get; set; }

        [DataMember(Name="collectionSettingsId")]
        public virtual string CollectionSettingsId { get; set; }
    }

    [DataContract]
    public partial class V4BaseRequest
    {
    }

}

namespace CollectionsAPI.ServiceModel.V4.Responses
{
    [DataContract]
    public partial class PostCollectionResponse
        : V4BaseResponse, IPostCollectionResponse
    {
        [DataMember(Name="data")]
        public virtual IPostCollectionResponseData Data { get; set; }
    }

    [DataContract]
    public partial class V4BaseResponse
    {
        [DataMember(Name="status")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# PostCollectionRequest DTOs

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

HTTP + OTHER

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

POST /v4/collections HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"title":"String","collectionSettingsId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}