| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, SuperAdminVisma |
| DELETE | /references/{companyid}/{Id} | Delete a reference | Delete 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
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class DeleteReference
Implements 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 Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''Id of the reference
'''</Summary>
<ApiMember(Description:="Id of the reference", IsRequired:=true, ParameterType:="path")>
Public Overridable Property Id As Guid
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
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}