| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, SuperAdminVisma |
| PUT | /references/{Id} | Update a reference | Update a reference |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ReferenceQueryResponse() =
///<summary>
///The company id
///</summary>
[<ApiMember(Description="The company id")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///Id of the reference
///</summary>
[<ApiMember(Description="Id of the reference")>]
member val Id:Guid = new Guid() with get,set
///<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")>]
member val OwnerId:Guid = new Guid() with get,set
///<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")>]
member val ReferenceType:String = null with get,set
///<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")>]
member val ExternalData:String = null with get,set
///<summary>
///Will show when the reference was updated.
///</summary>
[<ApiMember(DataType="datetime", Description="Will show when the reference was updated.")>]
member val Updated:DateTime = new DateTime() with get,set
///<summary>
///Will show when the reference was created.
///</summary>
[<ApiMember(DataType="datetime", Description="Will show when the reference was created.")>]
member val Created:DateTime = new DateTime() with get,set
///<summary>
///Will show who created the reference.
///</summary>
[<ApiMember(DataType="datetime", Description="Will show who created the reference.")>]
member val CreatedBy:String = null with get,set
///<summary>
///Will show who update the reference.
///</summary>
[<ApiMember(DataType="datetime", Description="Will show who update the reference.")>]
member val UpdatedBy:String = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type UpdateReference() =
///<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.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Id of the reference
///</summary>
[<ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")>]
member val Id:Guid = new Guid() with get,set
///<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")>]
member val OwnerId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<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")>]
member val ReferenceType:String = null with get,set
///<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")>]
member val ExternalData:String = null with get,set
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>