BokaMera.API.Host

<back to all web services

AddReference

The following routes are available for this service:
POST/referencesAdd referenceAdd reference
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AddReference
        : ICompany
    {
        ///<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.")]
        public virtual Guid? CompanyId { 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")]
        public virtual Guid OwnerId { 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")]
        public virtual string ReferenceType { 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")]
        public virtual string ExternalData { get; set; }

        ///<summary>
        ///Will show who created the reference.
        ///</summary>
        [ApiMember(DataType="datetime", Description="Will show who created the reference.")]
        public virtual string CreatedBy { get; set; }
    }

    public partial class ReferenceQueryResponse
    {
        ///<summary>
        ///The company id
        ///</summary>
        [ApiMember(Description="The company id")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///Id of the reference
        ///</summary>
        [ApiMember(Description="Id of the reference")]
        public virtual Guid Id { 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")]
        public virtual Guid OwnerId { 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")]
        public virtual string ReferenceType { 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")]
        public virtual string ExternalData { get; set; }

        ///<summary>
        ///Will show when the reference was updated.
        ///</summary>
        [ApiMember(DataType="datetime", Description="Will show when the reference was updated.")]
        public virtual DateTime Updated { get; set; }

        ///<summary>
        ///Will show when the reference was created.
        ///</summary>
        [ApiMember(DataType="datetime", Description="Will show when the reference was created.")]
        public virtual DateTime Created { get; set; }

        ///<summary>
        ///Will show who created the reference.
        ///</summary>
        [ApiMember(DataType="datetime", Description="Will show who created the reference.")]
        public virtual string CreatedBy { get; set; }

        ///<summary>
        ///Will show who update the reference.
        ///</summary>
        [ApiMember(DataType="datetime", Description="Will show who update the reference.")]
        public virtual string UpdatedBy { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# AddReference DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

{"CompanyId":"00000000-0000-0000-0000-000000000000","ReferenceType":"String","ExternalData":"String","CreatedBy":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}