| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, SuperAdminVisma |
| PUT | /references/{Id} | Update a reference | Update 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 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
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class UpdateReference
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
'''<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 Nullable(Of 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
End Class
End Namespace
End Namespace
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.
PUT /references/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateReference 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>
<ExternalData>String</ExternalData>
<Id>00000000-0000-0000-0000-000000000000</Id>
<OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
<ReferenceType>String</ReferenceType>
</UpdateReference>
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>