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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class DeleteReferenceWithReferenceType
            '''<Summary>
            '''The company id
            '''</Summary>
            <ApiMember(Description:="The company id", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property CompanyId As Guid

            '''<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 Overridable Property OwnerId As Guid

            '''<Summary>
            '''Reference type of the reference
            '''</Summary>
            <ApiMember(Description:="Reference type of the reference", ParameterType:="path")>
            Public Overridable Property ReferenceType As String
        End Class

        Public Partial Class ReferenceQueryResponse
            '''<Summary>
            '''The company id
            '''</Summary>
            <ApiMember(Description:="The company id")>
            Public Overridable Property CompanyId As Guid

            '''<Summary>
            '''Id of the reference
            '''</Summary>
            <ApiMember(Description:="Id of the reference")>
            Public Overridable Property Id As Guid

            '''<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 Overridable Property OwnerId As Guid

            '''<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 Overridable Property ReferenceType As String

            '''<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 Overridable Property ExternalData As String

            '''<Summary>
            '''Will show when the reference was updated.
            '''</Summary>
            <ApiMember(DataType:="datetime", Description:="Will show when the reference was updated.")>
            Public Overridable Property Updated As Date

            '''<Summary>
            '''Will show when the reference was created.
            '''</Summary>
            <ApiMember(DataType:="datetime", Description:="Will show when the reference was created.")>
            Public Overridable Property Created As Date

            '''<Summary>
            '''Will show who created the reference.
            '''</Summary>
            <ApiMember(DataType:="datetime", Description:="Will show who created the reference.")>
            Public Overridable Property CreatedBy As String

            '''<Summary>
            '''Will show who update the reference.
            '''</Summary>
            <ApiMember(DataType:="datetime", Description:="Will show who update the reference.")>
            Public Overridable Property UpdatedBy As String

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}