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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	userAuthId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	groupId: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}