| DELETE | /references/{companyid}/{ownerid}/{referencetype} | Delete a reference with the reference type | Delete 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 .xml suffix or ?format=xml
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/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>