BokaMera.API.Host

<back to all web services

DeleteReferenceWithReferenceType

The following routes are available for this service:
DELETE/references/{companyid}/{ownerid}/{referencetype}Delete a reference with the reference typeDelete a 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 DeleteReferenceWithReferenceType
    {
        ///<summary>
        ///The company id
        ///</summary>
        [ApiMember(Description="The company id", IsRequired=true, ParameterType="path")]
        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", ParameterType="path")]
        public virtual Guid OwnerId { get; set; }

        ///<summary>
        ///Reference type of the reference
        ///</summary>
        [ApiMember(Description="Reference type of the reference", ParameterType="path")]
        public virtual string ReferenceType { 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# DeleteReferenceWithReferenceType 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.

DELETE /references/{companyid}/{ownerid}/{referencetype} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
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"}}}