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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class DeleteReference implements ICompany
    {
        /**
        * The company id, if empty will use the company id for the user you are logged in with.
        */
        @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        public UUID CompanyId = null;

        /**
        * Id of the reference
        */
        @ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")
        public UUID Id = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public DeleteReference setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public UUID getId() { return Id; }
        public DeleteReference setId(UUID value) { this.Id = value; return this; }
    }

    public static class ReferenceQueryResponse
    {
        /**
        * The company id
        */
        @ApiMember(Description="The company id")
        public UUID CompanyId = null;

        /**
        * Id of the reference
        */
        @ApiMember(Description="Id of the reference")
        public UUID Id = null;

        /**
        * Internal Id of the reference. Example could be the Booking Id
        */
        @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
        public UUID OwnerId = null;

        /**
        * The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
        */
        @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 String ReferenceType = null;

        /**
        * The external data. Could be a Id or a JSON object or anything
        */
        @ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
        public String ExternalData = null;

        /**
        * Will show when the reference was updated.
        */
        @ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
        public Date Updated = null;

        /**
        * Will show when the reference was created.
        */
        @ApiMember(DataType="datetime", Description="Will show when the reference was created.")
        public Date Created = null;

        /**
        * Will show who created the reference.
        */
        @ApiMember(DataType="datetime", Description="Will show who created the reference.")
        public String CreatedBy = null;

        /**
        * Will show who update the reference.
        */
        @ApiMember(DataType="datetime", Description="Will show who update the reference.")
        public String UpdatedBy = null;

        public ResponseStatus ResponseStatus = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public ReferenceQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public UUID getId() { return Id; }
        public ReferenceQueryResponse setId(UUID value) { this.Id = value; return this; }
        public UUID getOwnerId() { return OwnerId; }
        public ReferenceQueryResponse setOwnerId(UUID value) { this.OwnerId = value; return this; }
        public String getReferenceType() { return ReferenceType; }
        public ReferenceQueryResponse setReferenceType(String value) { this.ReferenceType = value; return this; }
        public String getExternalData() { return ExternalData; }
        public ReferenceQueryResponse setExternalData(String value) { this.ExternalData = value; return this; }
        public Date getUpdated() { return Updated; }
        public ReferenceQueryResponse setUpdated(Date value) { this.Updated = value; return this; }
        public Date getCreated() { return Created; }
        public ReferenceQueryResponse setCreated(Date value) { this.Created = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public ReferenceQueryResponse setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public String getUpdatedBy() { return UpdatedBy; }
        public ReferenceQueryResponse setUpdatedBy(String value) { this.UpdatedBy = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ReferenceQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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>