BokaMera.API.Host

AddReference

The following routes are available for this service:
POST	/references	Add reference	Add reference

namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ReferenceQueryResponse() = 
        member val CompanyId:Guid = new Guid() with get,set
        member val Id:Guid = new Guid() with get,set
        member val OwnerId:Guid = new Guid() with get,set
        member val ReferenceType:String = null with get,set
        member val ReferenceTypeId:Int32 = new Int32() with get,set
        member val ExternalData:String = null with get,set
        member val Updated:DateTime = new DateTime() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val CreatedBy:String = null with get,set
        member val UpdatedBy:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type AddReference() = 
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Internal Id of the reference. Example could be the Booking Id
        ///</summary>
        [<ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")>]
        member val OwnerId:Guid = new Guid() with get,set

        ///<summary>
        ///The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
        ///</summary>
        [<ApiMember(Description="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")>]
        member val ReferenceType:String = null with get,set

        ///<summary>
        ///External reference type id - can we fetched from /externalreferencestypes endpoint
        ///</summary>
        [<ApiMember(Description="External reference type id - can we fetched from /externalreferencestypes endpoint")>]
        member val ReferenceTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The external data. Could be a Id or a JSON object or anything
        ///</summary>
        [<ApiMember(Description="The external data. Could be a Id or a JSON object or anything")>]
        member val ExternalData:String = null with get,set

        ///<summary>
        ///Will show who created the reference.
        ///</summary>
        [<ApiMember(DataType="datetime", Description="Will show who created the reference.")>]
        member val CreatedBy:String = null with get,set

F# AddReference 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 /references HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ReferenceType: String,
	ReferenceTypeId: 0,
	ExternalData: String,
	CreatedBy: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ReferenceType: String,
	ReferenceTypeId: 0,
	ExternalData: String,
	CreatedBy: String,
	UpdatedBy: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}