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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReferenceQueryResponse:
    # @ApiMember(Description="The company id")
    company_id: Optional[str] = None
    """
    The company id
    """


    # @ApiMember(Description="Id of the reference")
    id: Optional[str] = None
    """
    Id of the reference
    """


    # @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
    owner_id: Optional[str] = None
    """
    Internal Id of the reference. Example could be the Booking Id
    """


    # @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")
    reference_type: Optional[str] = None
    """
    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 external data. Could be a Id or a JSON object or anything")
    external_data: Optional[str] = None
    """
    The external data. Could be a Id or a JSON object or anything
    """


    # @ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
    updated: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    Will show when the reference was updated.
    """


    # @ApiMember(DataType="datetime", Description="Will show when the reference was created.")
    created: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    Will show when the reference was created.
    """


    # @ApiMember(DataType="datetime", Description="Will show who created the reference.")
    created_by: Optional[str] = None
    """
    Will show who created the reference.
    """


    # @ApiMember(DataType="datetime", Description="Will show who update the reference.")
    updated_by: Optional[str] = None
    """
    Will show who update the reference.
    """


    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteReferenceWithReferenceType:
    # @ApiMember(Description="The company id", IsRequired=true, ParameterType="path")
    company_id: Optional[str] = None
    """
    The company id
    """


    # @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id", ParameterType="path")
    owner_id: Optional[str] = None
    """
    Internal Id of the reference. Example could be the Booking Id
    """


    # @ApiMember(Description="Reference type of the reference", ParameterType="path")
    reference_type: Optional[str] = None
    """
    Reference type of the reference
    """

Python DeleteReferenceWithReferenceType DTOs

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

HTTP + JSV

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: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}