Booklinker.API

<back to all web services

PostGroupRequest

The following routes are available for this service:
POST/v1/groups
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Booklinker.API.ServiceModel.V1.Requests
Imports Booklinker.API.ServiceModel.V1.Responses

Namespace Global

    Namespace Booklinker.API.ServiceModel.V1.Requests

        <DataContract>
        Public Partial Class PostGroupRequest
            <DataMember(Name:="userAuthId")>
            <ApiMember(IsRequired:=true, Name:="userAuthId")>
            Public Overridable Property UserAuthId As UInt32
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V1.Responses

        <DataContract>
        Public Partial Class PostGroupResponse
            Implements IPostGroupResponse
            <DataMember(Name:="groupId")>
            Public Overridable Property GroupId As Long Implements IPostGroupResponse.GroupId

            <DataMember(Name:="responseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

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

<PostGroupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Requests">
  <userAuthId>0</userAuthId>
</PostGroupRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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