Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /bookings/{Id}/resource | Change a resource on a booking | Update an existing booking with a another available resource. |
---|
export enum BookingStatusEnum
{
Booked = 1,
Unbooked = 2,
Reserved = 3,
Canceled = 4,
AwaitingPayment = 5,
AwaitingPaymentNoTimeLimit = 6,
Payed = 7,
AwaitingPaymentRequestFromAdmin = 8,
AwaitingPaymentFromProvider = 9,
Invoiced = 10,
}
export class BookingStatusQueryResponse
{
public Id: number;
public Name: string;
public Description: string;
public Icon: string;
public Color: string;
public constructor(init?: Partial<BookingStatusQueryResponse>) { (Object as any).assign(this, init); }
}
export class CustomFieldValueResponse
{
public Value: string;
public constructor(init?: Partial<CustomFieldValueResponse>) { (Object as any).assign(this, init); }
}
export class CustomFieldConfigData
{
/** @description Custom field id */
// @ApiMember(Description="Custom field id")
public Id: number;
/** @description Configuration name. Example: 'Number of persons'. */
// @ApiMember(Description="Configuration name. Example: 'Number of persons'.")
public Name: string;
/** @description Custom field description. Example: 'For how many persons is this booking?' */
// @ApiMember(Description="Custom field description. Example: 'For how many persons is this booking?'")
public Description: string;
/** @description Field width. Example: 20 for 20px */
// @ApiMember(Description="Field width. Example: 20 for 20px")
public Width?: number;
/** @description Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' */
// @ApiMember(Description="Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'")
public DataType: string;
/** @description Default value of the field. Example: '3' */
// @ApiMember(Description="Default value of the field. Example: '3'")
public DefaultValue: string;
/** @description Determines if the field is required to have a value or not */
// @ApiMember(Description="Determines if the field is required to have a value or not")
public IsMandatory: boolean;
/** @description Error message shown to the user if the field data is required but not entered */
// @ApiMember(Description="Error message shown to the user if the field data is required but not entered")
public MandatoryErrorMessage: string;
/** @description Max lenght of the field */
// @ApiMember(Description="Max lenght of the field")
public MaxLength: number;
/** @description If the field should have multiple lines */
// @ApiMember(Description="If the field should have multiple lines")
public MultipleLineText: boolean;
/** @description Regular expression used for validation of the field */
// @ApiMember(Description="Regular expression used for validation of the field")
public RegEx: string;
/** @description Error message shown if the regular expression validation failed */
// @ApiMember(Description="Error message shown if the regular expression validation failed")
public RegExErrorMessage: string;
/** @description The values to select from if Datatype is DropDown for this custom field */
// @ApiMember(Description="The values to select from if Datatype is DropDown for this custom field")
public Values: CustomFieldValueResponse[];
public constructor(init?: Partial<CustomFieldConfigData>) { (Object as any).assign(this, init); }
}
export class CustomFieldDataResponse
{
public Id: number;
public Column: string;
public Name: string;
public Description: string;
public Value: string;
/** @description Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' */
// @ApiMember(Description="Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'")
public DataType: string;
public constructor(init?: Partial<CustomFieldDataResponse>) { (Object as any).assign(this, init); }
}
export class BookedResource
{
public Id: number;
public Name: string;
public Color: string;
public ImageUrl: string;
public Email: string;
public MobilePhone: string;
public AccessGroup: string;
public EmailNotification: boolean;
public SMSNotification: boolean;
public EmailReminder: boolean;
public SMSReminder: boolean;
public constructor(init?: Partial<BookedResource>) { (Object as any).assign(this, init); }
}
export class BookedResourceType
{
/** @description The resource type id */
// @ApiMember(Description="The resource type id")
public Id: number;
/** @description The resource type name */
// @ApiMember(Description="The resource type name")
public Name: string;
/** @description The resources inside resource type */
// @ApiMember(Description="The resources inside resource type")
public Resources: BookedResource[];
public constructor(init?: Partial<BookedResourceType>) { (Object as any).assign(this, init); }
}
export class BookedCompany
{
public Id: string;
public Name: string;
public LogoType: string;
public Category: string;
public Street1: string;
public Street2: string;
public ZipCode: string;
public City: string;
public CountryId: string;
public Longitude: string;
public Latitude: string;
public Phone: string;
public Email: string;
public HomePage: string;
public SitePath: string;
public IsFavorite: boolean;
public PaymentProviderId?: number;
public constructor(init?: Partial<BookedCompany>) { (Object as any).assign(this, init); }
}
export class BookedCustomer
{
public Id: string;
public Firstname: string;
public Lastname: string;
public Email: string;
public Phone: string;
public FacebookUserName: string;
public ImageUrl: string;
public CorporateIdentityNumber: string;
public InvoiceAddress1: string;
public InvoiceAddress2: string;
public InvoiceCity: string;
public InvoicePostalCode: string;
public InvoiceCountryCode: string;
public constructor(init?: Partial<BookedCustomer>) { (Object as any).assign(this, init); }
}
export class BookedQuantity
{
/** @description The quantity Id */
// @ApiMember(Description="The quantity Id")
public Id: number;
/** @description The quantity for booked on this price category */
// @ApiMember(Description="The quantity for booked on this price category")
public Quantity: number;
/** @description The price */
// @ApiMember(Description="The price")
public Price?: number;
/** @description The price bofore rebate codes */
// @ApiMember(Description="The price bofore rebate codes")
public PriceBeforeRebate?: number;
/** @description The price currency */
// @ApiMember(Description="The price currency")
public CurrencyId: string;
/** @description The price sign */
// @ApiMember(Description="The price sign")
public PriceSign: string;
/** @description The price category */
// @ApiMember(Description="The price category")
public Category: string;
/** @description The price VAT in percent */
// @ApiMember(Description="The price VAT in percent")
public VAT?: number;
/** @description The price text to display */
// @ApiMember(Description="The price text to display")
public PriceText: string;
/** @description If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information. */
// @ApiMember(Description="If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.")
public OccupiesSpot: boolean;
public constructor(init?: Partial<BookedQuantity>) { (Object as any).assign(this, init); }
}
export class GroupBookingSettings
{
public Active: boolean;
public Min: number;
public Max: number;
public constructor(init?: Partial<GroupBookingSettings>) { (Object as any).assign(this, init); }
}
export class MultipleResourceSettings
{
public Active: boolean;
public Min: number;
public Max: number;
public constructor(init?: Partial<MultipleResourceSettings>) { (Object as any).assign(this, init); }
}
export class ServiceInfoResponse
{
public Id: number;
public Name: string;
public Description: string;
public ImageUrl: string;
public LengthInMinutes?: number;
public MaxNumberOfSpotsPerBooking: number;
public MinNumberOfSpotsPerBooking: number;
public GroupBooking: GroupBookingSettings;
public MultipleResource: MultipleResourceSettings;
public IsGroupBooking: boolean;
public IsPaymentEnabled: boolean;
public constructor(init?: Partial<ServiceInfoResponse>) { (Object as any).assign(this, init); }
}
export class BookingLogEventTypeResponse
{
/** @description The event type id */
// @ApiMember(Description="The event type id")
public Id: number;
/** @description The event type name */
// @ApiMember(Description="The event type name")
public Name: string;
/** @description The event type description */
// @ApiMember(Description="The event type description")
public Description: string;
public constructor(init?: Partial<BookingLogEventTypeResponse>) { (Object as any).assign(this, init); }
}
export class BookingLogQueryResponse
{
/** @description The booking log id */
// @ApiMember(Description="The booking log id")
public Id: number;
/** @description The booking id */
// @ApiMember(Description="The booking id")
public BookingId: number;
/** @description The type of event */
// @ApiMember(Description="The type of event")
public EventTypeId: number;
/** @description The type of event */
// @ApiMember(Description="The type of event")
public EventType: BookingLogEventTypeResponse;
/** @description Comments that could be added to the event log item */
// @ApiMember(Description="Comments that could be added to the event log item")
public Comments: string;
/** @description The user created the event */
// @ApiMember(Description="The user created the event")
public UserName: string;
/** @description Then date when the event occured */
// @ApiMember(Description="Then date when the event occured")
public Created: string;
public constructor(init?: Partial<BookingLogQueryResponse>) { (Object as any).assign(this, init); }
}
export class CurrencyInfoResponse
{
/** @description The currency id */
// @ApiMember(Description="The currency id")
public Id: string;
/** @description The currency id */
// @ApiMember(Description="The currency id")
public Name: string;
/** @description The currency id */
// @ApiMember(Description="The currency id")
public CurrencySign: string;
public constructor(init?: Partial<CurrencyInfoResponse>) { (Object as any).assign(this, init); }
}
export class BookingPaymentLogQueryResponse
{
/** @description The booking payment log id */
// @ApiMember(Description="The booking payment log id")
public Id: number;
/** @description The booking id */
// @ApiMember(Description="The booking id")
public BookingId: number;
/** @description The payment reference id */
// @ApiMember(Description="The payment reference id")
public PaymentReferenceId: string;
/** @description The payment order item reference id */
// @ApiMember(Description="The payment order item reference id")
public OrderItemReferenceId: string;
/** @description The payment reference id */
// @ApiMember(Description="The payment reference id")
public PaymentProviderId?: number;
/** @description The payment amount */
// @ApiMember(Description="The payment amount")
public Amount: number;
/** @description The payment VAT in percent */
// @ApiMember(Description="The payment VAT in percent")
public VAT: number;
/** @description The payment amount that is credited */
// @ApiMember(Description="The payment amount that is credited")
public AmountCredited: number;
/** @description The payment currency id */
// @ApiMember(Description="The payment currency id")
public CurrencyId: string;
/** @description The payment currency info */
// @ApiMember(Description="The payment currency info")
public CurrencyInfo: CurrencyInfoResponse;
/** @description Comments that could be added to the event log item */
// @ApiMember(Description="Comments that could be added to the event log item")
public Comments: string;
/** @description The date when the payment items was created */
// @ApiMember(Description="The date when the payment items was created")
public Created: string;
/** @description The date when the payment items was update */
// @ApiMember(Description="The date when the payment items was update")
public Updated: string;
public constructor(init?: Partial<BookingPaymentLogQueryResponse>) { (Object as any).assign(this, init); }
}
export class BookingCheckoutQueryResponse
{
/** @description The checkout id */
// @ApiMember(Description="The checkout id")
public Id: string;
/** @description The booking id */
// @ApiMember(Description="The booking id")
public BookingId: number;
/** @description The purchase id */
// @ApiMember(Description="The purchase id")
public PurchaseId?: number;
/** @description The payment checkout expiration datetime */
// @ApiMember(Description="The payment checkout expiration datetime")
public ExpirationTime?: string;
/** @description The payment snippet code */
// @ApiMember(Description="The payment snippet code")
public Snippet: string;
/** @description The payment status */
// @ApiMember(Description="The payment status")
public Status: string;
/** @description Log message */
// @ApiMember(Description="Log message")
public Message: string;
/** @description When the checkout log item was created */
// @ApiMember(Description="When the checkout log item was created")
public Created: string;
/** @description When the checkout log item was updated */
// @ApiMember(Description="When the checkout log item was updated")
public Updated: string;
public constructor(init?: Partial<BookingCheckoutQueryResponse>) { (Object as any).assign(this, init); }
}
export class ExternalReferenceResponse
{
public CompanyId: string;
public Id: string;
public OwnerId: string;
public ReferenceType: string;
public ExternalData: string;
public CreatedBy: string;
public Updated: string;
public Created: string;
public constructor(init?: Partial<ExternalReferenceResponse>) { (Object as any).assign(this, init); }
}
export class BookingCalendarExportStatus
{
public CalendarId: string;
public BookingId: number;
public Synced?: boolean;
public constructor(init?: Partial<BookingCalendarExportStatus>) { (Object as any).assign(this, init); }
}
export class BookingQueryResponse
{
public Id: number;
public CompanyId: string;
public From: string;
public To: string;
public Status: BookingStatusEnum;
public StatusId: number;
public StatusName: string;
public StatusInfo: BookingStatusQueryResponse;
public SendEmailReminder: boolean;
public SendSmsReminder: boolean;
public SendSmsConfirmation: boolean;
public SendEmailConfirmation: boolean;
public LastTimeToUnBook?: string;
public CustomFields: CustomFieldConfigData[];
public CustomFieldValues: CustomFieldDataResponse[];
public BookedResourceTypes: BookedResourceType[];
public Company: BookedCompany;
public Customer: BookedCustomer;
public Quantities: BookedQuantity[];
public Service: ServiceInfoResponse;
public PaymentExpiration?: string;
public Log: BookingLogQueryResponse[];
public PaymentLog: BookingPaymentLogQueryResponse[];
public CheckoutLog: BookingCheckoutQueryResponse[];
public ExternalReference: ExternalReferenceResponse[];
public ResponseStatus: ResponseStatus;
public CalendarExportStatus: BookingCalendarExportStatus;
public LengthInMinutes?: number;
public BookedBy: string;
public BookedComments: string;
public UnbookedComments: string;
public CommentsToCustomer: string;
public CreatedDate: string;
public UpdatedDate: string;
public UnbookedOn?: string;
public CancellationCode: string;
public RatingCode: string;
public constructor(init?: Partial<BookingQueryResponse>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
export class ChangeResourceOnBooking implements ICompany
{
/** @description 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.")
public CompanyId?: string;
/** @description Id of the booking */
// @ApiMember(Description="Id of the booking", IsRequired=true, ParameterType="path")
public Id: number;
/** @description The resource type id */
// @ApiMember(Description="The resource type id")
public ResourceTypeId: number;
/** @description The resource id you want to replace */
// @ApiMember(Description="The resource id you want to replace")
public ResourceId: number;
/** @description The resource id to be replaced with */
// @ApiMember(Description="The resource id to be replaced with")
public NewResourceId: number;
public constructor(init?: Partial<ChangeResourceOnBooking>) { (Object as any).assign(this, init); }
}
TypeScript ChangeResourceOnBooking DTOs
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 /bookings/{Id}/resource HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ChangeResourceOnBooking 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>
<Id>0</Id>
<NewResourceId>0</NewResourceId>
<ResourceId>0</ResourceId>
<ResourceTypeId>0</ResourceTypeId>
</ChangeResourceOnBooking>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <BookingQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <BookedBy>String</BookedBy> <BookedComments>String</BookedComments> <BookedResourceTypes> <BookedResourceType> <Id>0</Id> <Name>String</Name> <Resources> <BookedResource> <AccessGroup>String</AccessGroup> <Color>String</Color> <Email>String</Email> <EmailNotification>false</EmailNotification> <EmailReminder>false</EmailReminder> <Id>0</Id> <ImageUrl i:nil="true" /> <MobilePhone>String</MobilePhone> <Name>String</Name> <SMSNotification>false</SMSNotification> <SMSReminder>false</SMSReminder> </BookedResource> </Resources> </BookedResourceType> </BookedResourceTypes> <CalendarExportStatus> <BookingId>0</BookingId> <CalendarId>String</CalendarId> <Synced>false</Synced> </CalendarExportStatus> <CancellationCode>String</CancellationCode> <CheckoutLog> <BookingCheckoutQueryResponse> <BookingId>0</BookingId> <Created>0001-01-01T00:00:00</Created> <ExpirationTime>0001-01-01T00:00:00</ExpirationTime> <Id>00000000-0000-0000-0000-000000000000</Id> <Message>String</Message> <PurchaseId>0</PurchaseId> <Snippet>String</Snippet> <Status>String</Status> <Updated>0001-01-01T00:00:00</Updated> </BookingCheckoutQueryResponse> </CheckoutLog> <CommentsToCustomer>String</CommentsToCustomer> <Company> <Category>String</Category> <City>String</City> <CountryId>String</CountryId> <Email>String</Email> <HomePage>String</HomePage> <Id>00000000-0000-0000-0000-000000000000</Id> <IsFavorite>false</IsFavorite> <Latitude>String</Latitude> <LogoType i:nil="true" /> <Longitude>String</Longitude> <Name>String</Name> <PaymentProviderId>0</PaymentProviderId> <Phone>String</Phone> <SitePath>String</SitePath> <Street1>String</Street1> <Street2>String</Street2> <ZipCode>String</ZipCode> </Company> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <CreatedDate>0001-01-01T00:00:00</CreatedDate> <CustomFieldValues> <CustomFieldDataResponse> <Column>String</Column> <DataType>String</DataType> <Description>String</Description> <Id>0</Id> <Name>String</Name> <Value>String</Value> </CustomFieldDataResponse> </CustomFieldValues> <CustomFields> <CustomFieldConfigData> <DataType>String</DataType> <DefaultValue>String</DefaultValue> <Description>String</Description> <Id>0</Id> <IsMandatory>false</IsMandatory> <MandatoryErrorMessage>String</MandatoryErrorMessage> <MaxLength>0</MaxLength> <MultipleLineText>false</MultipleLineText> <Name>String</Name> <RegEx>String</RegEx> <RegExErrorMessage>String</RegExErrorMessage> <Values> <CustomFieldValueResponse> <Value>String</Value> </CustomFieldValueResponse> </Values> <Width>0</Width> </CustomFieldConfigData> </CustomFields> <Customer> <CorporateIdentityNumber>String</CorporateIdentityNumber> <Email>String</Email> <FacebookUserName>String</FacebookUserName> <Firstname>String</Firstname> <Id>00000000-0000-0000-0000-000000000000</Id> <ImageUrl>String</ImageUrl> <InvoiceAddress1>String</InvoiceAddress1> <InvoiceAddress2>String</InvoiceAddress2> <InvoiceCity>String</InvoiceCity> <InvoiceCountryCode>String</InvoiceCountryCode> <InvoicePostalCode>String</InvoicePostalCode> <Lastname>String</Lastname> <Phone>String</Phone> </Customer> <ExternalReference> <ExternalReferenceResponse> <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> <Updated>0001-01-01T00:00:00</Updated> </ExternalReferenceResponse> </ExternalReference> <From>0001-01-01T00:00:00</From> <Id>0</Id> <LastTimeToUnBook>0001-01-01T00:00:00</LastTimeToUnBook> <LengthInMinutes>0</LengthInMinutes> <Log> <BookingLogQueryResponse> <BookingId>0</BookingId> <Comments>String</Comments> <Created>0001-01-01T00:00:00</Created> <EventType> <Description>String</Description> <Id>0</Id> <Name>String</Name> </EventType> <EventTypeId>0</EventTypeId> <Id>0</Id> <UserName>String</UserName> </BookingLogQueryResponse> </Log> <PaymentExpiration>0001-01-01T00:00:00</PaymentExpiration> <PaymentLog> <BookingPaymentLogQueryResponse> <Amount>0</Amount> <AmountCredited>0</AmountCredited> <BookingId>0</BookingId> <Comments>String</Comments> <Created>0001-01-01T00:00:00</Created> <CurrencyId>String</CurrencyId> <CurrencyInfo> <CurrencySign>String</CurrencySign> <Id>String</Id> <Name>String</Name> </CurrencyInfo> <Id>0</Id> <OrderItemReferenceId>String</OrderItemReferenceId> <PaymentProviderId>0</PaymentProviderId> <PaymentReferenceId>String</PaymentReferenceId> <Updated>0001-01-01T00:00:00</Updated> <VAT>0</VAT> </BookingPaymentLogQueryResponse> </PaymentLog> <Quantities> <BookedQuantity> <Category>String</Category> <CurrencyId>String</CurrencyId> <Id>0</Id> <OccupiesSpot>false</OccupiesSpot> <Price>0</Price> <PriceBeforeRebate>0</PriceBeforeRebate> <PriceSign>String</PriceSign> <PriceText>String</PriceText> <Quantity>0</Quantity> <VAT>0</VAT> </BookedQuantity> </Quantities> <RatingCode>String</RatingCode> <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> <SendEmailConfirmation>false</SendEmailConfirmation> <SendEmailReminder>false</SendEmailReminder> <SendSmsConfirmation>false</SendSmsConfirmation> <SendSmsReminder>false</SendSmsReminder> <Service> <Description>String</Description> <GroupBooking> <Active>false</Active> <Max>0</Max> <Min>0</Min> </GroupBooking> <Id>0</Id> <ImageUrl i:nil="true" /> <IsGroupBooking>false</IsGroupBooking> <IsPaymentEnabled>false</IsPaymentEnabled> <LengthInMinutes>0</LengthInMinutes> <MaxNumberOfSpotsPerBooking>0</MaxNumberOfSpotsPerBooking> <MinNumberOfSpotsPerBooking>0</MinNumberOfSpotsPerBooking> <MultipleResource> <Active>false</Active> <Max>0</Max> <Min>0</Min> </MultipleResource> <Name>String</Name> </Service> <Status>Booked</Status> <StatusId>0</StatusId> <StatusInfo> <Color>String</Color> <Description>String</Description> <Icon>String</Icon> <Id>0</Id> <Name>String</Name> </StatusInfo> <StatusName>String</StatusName> <To>0001-01-01T00:00:00</To> <UnbookedComments>String</UnbookedComments> <UnbookedOn>0001-01-01T00:00:00</UnbookedOn> <UpdatedDate>0001-01-01T00:00:00</UpdatedDate> </BookingQueryResponse>