Booklinker.API

<back to all web services

PutCollectionSettingsRequest

Requires Authentication
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Booklinker.API.ServiceModel.V2.Requests;
using CollectionsAPI.Contracts.DTOs;
using Booklinker.API.ServiceModel.V2.Responses;

namespace Booklinker.API.ServiceModel.V2.Requests
{
    [DataContract]
    public partial class CollectionSettingsBaseRequest
        : V2BaseRequest, ICollectionSettingsBaseRequest
    {
        [DataMember(Name="profileImageId")]
        public virtual string ProfileImageId { get; set; }

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

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

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

        [DataMember(Name="signatureAppearance")]
        public virtual SignatureAppearance SignatureAppearance { get; set; }
    }

    [DataContract]
    public partial class PutCollectionSettingsRequest
        : CollectionSettingsBaseRequest, IPutCollectionSettingsRequest
    {
        [DataMember(Name="id")]
        public virtual string Id { get; set; }
    }

    [DataContract]
    public partial class V2BaseRequest
    {
    }

}

namespace Booklinker.API.ServiceModel.V2.Responses
{
    [DataContract]
    public partial class PutCollectionSettingsResponse
        : V2BaseResponse
    {
    }

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

}

namespace CollectionsAPI.Contracts.DTOs
{
    public enum SignatureAppearance
    {
        [EnumMember(Value="none")]
        None,
        [EnumMember(Value="text")]
        Text,
        [EnumMember(Value="upload")]
        Upload,
    }

}

C# PutCollectionSettingsRequest DTOs

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/PutCollectionSettingsRequest HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutCollectionSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Requests">
  <profileImageId>String</profileImageId>
  <signatureAppearance>None</signatureAppearance>
  <signatureFont>String</signatureFont>
  <signatureImageId>String</signatureImageId>
  <signatureText>String</signatureText>
  <id>String</id>
</PutCollectionSettingsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PutCollectionSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses">
  <responseStatus 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>
  </responseStatus>
</PutCollectionSettingsResponse>