| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, SuperAdminVisma |
| PUT | /references/{Id} | Update a reference | Update a reference |
|---|
import 'package:servicestack/servicestack.dart';
class ReferenceQueryResponse implements IConvertible
{
/**
* The company id
*/
// @ApiMember(Description="The company id")
String? CompanyId;
/**
* Id of the reference
*/
// @ApiMember(Description="Id of the reference")
String? Id;
/**
* Internal Id of the reference. Example could be the Booking Id
*/
// @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
String? OwnerId;
/**
* 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 type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")
String? ReferenceType;
/**
* The external data. Could be a Id or a JSON object or anything
*/
// @ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
String? ExternalData;
/**
* Will show when the reference was updated.
*/
// @ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
DateTime? Updated;
/**
* Will show when the reference was created.
*/
// @ApiMember(DataType="datetime", Description="Will show when the reference was created.")
DateTime? Created;
/**
* Will show who created the reference.
*/
// @ApiMember(DataType="datetime", Description="Will show who created the reference.")
String? CreatedBy;
/**
* Will show who update the reference.
*/
// @ApiMember(DataType="datetime", Description="Will show who update the reference.")
String? UpdatedBy;
ResponseStatus? ResponseStatus;
ReferenceQueryResponse({this.CompanyId,this.Id,this.OwnerId,this.ReferenceType,this.ExternalData,this.Updated,this.Created,this.CreatedBy,this.UpdatedBy,this.ResponseStatus});
ReferenceQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
Id = json['Id'];
OwnerId = json['OwnerId'];
ReferenceType = json['ReferenceType'];
ExternalData = json['ExternalData'];
Updated = JsonConverters.fromJson(json['Updated'],'DateTime',context!);
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
CreatedBy = json['CreatedBy'];
UpdatedBy = json['UpdatedBy'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'Id': Id,
'OwnerId': OwnerId,
'ReferenceType': ReferenceType,
'ExternalData': ExternalData,
'Updated': JsonConverters.toJson(Updated,'DateTime',context!),
'Created': JsonConverters.toJson(Created,'DateTime',context!),
'CreatedBy': CreatedBy,
'UpdatedBy': UpdatedBy,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "ReferenceQueryResponse";
TypeContext? context = _ctx;
}
// @ValidateRequest(Validator="IsAuthenticated")
class UpdateReference implements ICompany, IConvertible
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
String? CompanyId;
/**
* Id of the reference
*/
// @ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")
String? Id;
/**
* Internal Id of the reference. Example could be the Booking Id
*/
// @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
String? OwnerId;
/**
* 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 type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")
String? ReferenceType;
/**
* The external data. Could be a Id or a JSON object or anything
*/
// @ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
String? ExternalData;
UpdateReference({this.CompanyId,this.Id,this.OwnerId,this.ReferenceType,this.ExternalData});
UpdateReference.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
Id = json['Id'];
OwnerId = json['OwnerId'];
ReferenceType = json['ReferenceType'];
ExternalData = json['ExternalData'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'Id': Id,
'OwnerId': OwnerId,
'ReferenceType': ReferenceType,
'ExternalData': ExternalData
};
getTypeName() => "UpdateReference";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'ReferenceQueryResponse': TypeInfo(TypeOf.Class, create:() => ReferenceQueryResponse()),
'UpdateReference': TypeInfo(TypeOf.Class, create:() => UpdateReference()),
});
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: testapi.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>