BokaMera.API.Host

<back to all web services

AddReference

The following routes are available for this service:
POST/referencesAdd referenceAdd reference
namespace BokaMera.API.ServiceModel.Dtos

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

    [<AllowNullLiteral>]
    type ReferenceQueryResponse() = 
        ///<summary>
        ///The company id
        ///</summary>
        [<ApiMember(Description="The company id")>]
        member val CompanyId:Guid = new Guid() with get,set

        ///<summary>
        ///Id of the reference
        ///</summary>
        [<ApiMember(Description="Id of the reference")>]
        member val Id:Guid = new 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>
        ///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 when the reference was updated.
        ///</summary>
        [<ApiMember(DataType="datetime", Description="Will show when the reference was updated.")>]
        member val Updated:DateTime = new DateTime() with get,set

        ///<summary>
        ///Will show when the reference was created.
        ///</summary>
        [<ApiMember(DataType="datetime", Description="Will show when the reference was created.")>]
        member val Created:DateTime = new DateTime() 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

        ///<summary>
        ///Will show who update the reference.
        ///</summary>
        [<ApiMember(DataType="datetime", Description="Will show who update the reference.")>]
        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>
        ///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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ReferenceType":"String","ExternalData":"String","CreatedBy":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ReferenceType":"String","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"}}}