BokaMera.API.Host

<back to all web services

DeleteReference

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, SuperAdminVisma
The following routes are available for this service:
DELETE/references/{companyid}/{Id}Delete a referenceDelete 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
{
    [ValidateRequest("IsAuthenticated")]
    public partial class DeleteReference
        : 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>
        ///Id of the reference
        ///</summary>
        [ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")]
        public virtual Guid Id { 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# DeleteReference DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /references/{companyid}/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReferenceQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <CreatedBy>String</CreatedBy>
  <ExternalData>String</ExternalData>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
  <ReferenceType>String</ReferenceType>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Updated>0001-01-01T00:00:00</Updated>
  <UpdatedBy>String</UpdatedBy>
</ReferenceQueryResponse>