BokaMera.API.Host

<back to all web services

DeleteRebateCode

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/rebatecodes/{Id}Delete RebateCode.Delete RebateCode.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class DeleteRebateCode implements ICompany
    {
        /**
        * 
        */
        @ApiMember(Description="")
        public UUID CompanyId = null;

        /**
        * Id of the rebate code
        */
        @ApiMember(Description="Id of the rebate code", IsRequired=true, ParameterType="path")
        public Integer Id = null;

        public Boolean ForceDelete = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public DeleteRebateCode setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public DeleteRebateCode setId(Integer value) { this.Id = value; return this; }
        public Boolean isForceDelete() { return ForceDelete; }
        public DeleteRebateCode setForceDelete(Boolean value) { this.ForceDelete = value; return this; }
    }

    public static class RebateCodeResponse
    {
        public Integer Id = null;
        public UUID CompanyId = null;
        public Date ValidFrom = null;
        public Date ValidTo = null;
        /**
        * If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
        */
        @ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
        public TimeSpan FromTime = null;

        /**
        * If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
        */
        @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
        public TimeSpan ToTime = null;

        public String CreatedBy = null;
        public Date Created = null;
        public String UpdatedBy = null;
        public Date Updated = null;
        public String PersonalNote = null;
        public String RebateCodeSign = null;
        public Integer RebateCodeValue = null;
        public Integer RebateCodeTypeId = null;
        public String Name = null;
        public Integer RebateCodeStatusId = null;
        public String StatusName = null;
        public Integer MaxNumberOfUses = null;
        public Integer MaxNumberOfUsesPerCustomer = null;
        public Integer NumberOfUsesUsed = null;
        public Integer NumberOfUsesPerCustomerUsed = null;
        public ArrayList<DaysOfWeekResponse> DaysOfWeek = null;
        public ArrayList<RebateCodeServiceResponse> Services = null;
        public ArrayList<RebateCodeCustomerResponse> Customers = null;
        public ArrayList<RebateCodeTypeResponse> RebateCodeTypesOptions = null;
        public ArrayList<RebateCodeStatusResponse> RebateCodeStatusOptions = null;
        public ResponseStatus ResponseStatus = null;
        
        public Integer getId() { return Id; }
        public RebateCodeResponse setId(Integer value) { this.Id = value; return this; }
        public UUID getCompanyId() { return CompanyId; }
        public RebateCodeResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Date getValidFrom() { return ValidFrom; }
        public RebateCodeResponse setValidFrom(Date value) { this.ValidFrom = value; return this; }
        public Date getValidTo() { return ValidTo; }
        public RebateCodeResponse setValidTo(Date value) { this.ValidTo = value; return this; }
        public TimeSpan getFromTime() { return FromTime; }
        public RebateCodeResponse setFromTime(TimeSpan value) { this.FromTime = value; return this; }
        public TimeSpan getToTime() { return ToTime; }
        public RebateCodeResponse setToTime(TimeSpan value) { this.ToTime = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public RebateCodeResponse setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Date getCreated() { return Created; }
        public RebateCodeResponse setCreated(Date value) { this.Created = value; return this; }
        public String getUpdatedBy() { return UpdatedBy; }
        public RebateCodeResponse setUpdatedBy(String value) { this.UpdatedBy = value; return this; }
        public Date getUpdated() { return Updated; }
        public RebateCodeResponse setUpdated(Date value) { this.Updated = value; return this; }
        public String getPersonalNote() { return PersonalNote; }
        public RebateCodeResponse setPersonalNote(String value) { this.PersonalNote = value; return this; }
        public String getRebateCodeSign() { return RebateCodeSign; }
        public RebateCodeResponse setRebateCodeSign(String value) { this.RebateCodeSign = value; return this; }
        public Integer getRebateCodeValue() { return RebateCodeValue; }
        public RebateCodeResponse setRebateCodeValue(Integer value) { this.RebateCodeValue = value; return this; }
        public Integer getRebateCodeTypeId() { return RebateCodeTypeId; }
        public RebateCodeResponse setRebateCodeTypeId(Integer value) { this.RebateCodeTypeId = value; return this; }
        public String getName() { return Name; }
        public RebateCodeResponse setName(String value) { this.Name = value; return this; }
        public Integer getRebateCodeStatusId() { return RebateCodeStatusId; }
        public RebateCodeResponse setRebateCodeStatusId(Integer value) { this.RebateCodeStatusId = value; return this; }
        public String getStatusName() { return StatusName; }
        public RebateCodeResponse setStatusName(String value) { this.StatusName = value; return this; }
        public Integer getMaxNumberOfUses() { return MaxNumberOfUses; }
        public RebateCodeResponse setMaxNumberOfUses(Integer value) { this.MaxNumberOfUses = value; return this; }
        public Integer getMaxNumberOfUsesPerCustomer() { return MaxNumberOfUsesPerCustomer; }
        public RebateCodeResponse setMaxNumberOfUsesPerCustomer(Integer value) { this.MaxNumberOfUsesPerCustomer = value; return this; }
        public Integer getNumberOfUsesUsed() { return NumberOfUsesUsed; }
        public RebateCodeResponse setNumberOfUsesUsed(Integer value) { this.NumberOfUsesUsed = value; return this; }
        public Integer getNumberOfUsesPerCustomerUsed() { return NumberOfUsesPerCustomerUsed; }
        public RebateCodeResponse setNumberOfUsesPerCustomerUsed(Integer value) { this.NumberOfUsesPerCustomerUsed = value; return this; }
        public ArrayList<DaysOfWeekResponse> getDaysOfWeek() { return DaysOfWeek; }
        public RebateCodeResponse setDaysOfWeek(ArrayList<DaysOfWeekResponse> value) { this.DaysOfWeek = value; return this; }
        public ArrayList<RebateCodeServiceResponse> getServices() { return Services; }
        public RebateCodeResponse setServices(ArrayList<RebateCodeServiceResponse> value) { this.Services = value; return this; }
        public ArrayList<RebateCodeCustomerResponse> getCustomers() { return Customers; }
        public RebateCodeResponse setCustomers(ArrayList<RebateCodeCustomerResponse> value) { this.Customers = value; return this; }
        public ArrayList<RebateCodeTypeResponse> getRebateCodeTypesOptions() { return RebateCodeTypesOptions; }
        public RebateCodeResponse setRebateCodeTypesOptions(ArrayList<RebateCodeTypeResponse> value) { this.RebateCodeTypesOptions = value; return this; }
        public ArrayList<RebateCodeStatusResponse> getRebateCodeStatusOptions() { return RebateCodeStatusOptions; }
        public RebateCodeResponse setRebateCodeStatusOptions(ArrayList<RebateCodeStatusResponse> value) { this.RebateCodeStatusOptions = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RebateCodeResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class DaysOfWeekResponse
    {
        public Integer Id = null;
        public String DayOfWeek = null;
        public String DayOfWeekTranslation = null;
        public Boolean DayOfWeekActive = null;
        public Short DayOfWeekSortOrder = null;
        
        public Integer getId() { return Id; }
        public DaysOfWeekResponse setId(Integer value) { this.Id = value; return this; }
        public String getDayOfWeek() { return DayOfWeek; }
        public DaysOfWeekResponse setDayOfWeek(String value) { this.DayOfWeek = value; return this; }
        public String getDayOfWeekTranslation() { return DayOfWeekTranslation; }
        public DaysOfWeekResponse setDayOfWeekTranslation(String value) { this.DayOfWeekTranslation = value; return this; }
        public Boolean isDayOfWeekActive() { return DayOfWeekActive; }
        public DaysOfWeekResponse setDayOfWeekActive(Boolean value) { this.DayOfWeekActive = value; return this; }
        public Short getDayOfWeekSortOrder() { return DayOfWeekSortOrder; }
        public DaysOfWeekResponse setDayOfWeekSortOrder(Short value) { this.DayOfWeekSortOrder = value; return this; }
    }

    public static class RebateCodeServiceResponse
    {
        public Integer Id = null;
        public String Name = null;
        public String Description = null;
        public Boolean Active = null;
        
        public Integer getId() { return Id; }
        public RebateCodeServiceResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public RebateCodeServiceResponse setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public RebateCodeServiceResponse setDescription(String value) { this.Description = value; return this; }
        public Boolean isActive() { return Active; }
        public RebateCodeServiceResponse setActive(Boolean value) { this.Active = value; return this; }
    }

    public static class RebateCodeCustomerResponse
    {
        public UUID Id = null;
        public String Firstname = null;
        public String Lastname = null;
        public String Email = null;
        public String Phone = null;
        public String ImageUrl = null;
        
        public UUID getId() { return Id; }
        public RebateCodeCustomerResponse setId(UUID value) { this.Id = value; return this; }
        public String getFirstname() { return Firstname; }
        public RebateCodeCustomerResponse setFirstname(String value) { this.Firstname = value; return this; }
        public String getLastname() { return Lastname; }
        public RebateCodeCustomerResponse setLastname(String value) { this.Lastname = value; return this; }
        public String getEmail() { return Email; }
        public RebateCodeCustomerResponse setEmail(String value) { this.Email = value; return this; }
        public String getPhone() { return Phone; }
        public RebateCodeCustomerResponse setPhone(String value) { this.Phone = value; return this; }
        public String getImageUrl() { return ImageUrl; }
        public RebateCodeCustomerResponse setImageUrl(String value) { this.ImageUrl = value; return this; }
    }

    public static class RebateCodeTypeResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<RebateCodeTypeItem> RebateCodeTypeItems = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RebateCodeTypeResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<RebateCodeTypeItem> getRebateCodeTypeItems() { return RebateCodeTypeItems; }
        public RebateCodeTypeResponse setRebateCodeTypeItems(ArrayList<RebateCodeTypeItem> value) { this.RebateCodeTypeItems = value; return this; }
    }

    public static class RebateCodeTypeItem
    {
        public Integer Id = null;
        public String Name = null;
        public String Description = null;
        
        public Integer getId() { return Id; }
        public RebateCodeTypeItem setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public RebateCodeTypeItem setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public RebateCodeTypeItem setDescription(String value) { this.Description = value; return this; }
    }

    public static class RebateCodeStatusResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<RebateCodeStatusItem> RebateCodeStatusItems = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RebateCodeStatusResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<RebateCodeStatusItem> getRebateCodeStatusItems() { return RebateCodeStatusItems; }
        public RebateCodeStatusResponse setRebateCodeStatusItems(ArrayList<RebateCodeStatusItem> value) { this.RebateCodeStatusItems = value; return this; }
    }

    public static class RebateCodeStatusItem
    {
        public Integer Id = null;
        public String RebateCodeStatusName = null;
        public String RebateCodeStatusDescription = null;
        
        public Integer getId() { return Id; }
        public RebateCodeStatusItem setId(Integer value) { this.Id = value; return this; }
        public String getRebateCodeStatusName() { return RebateCodeStatusName; }
        public RebateCodeStatusItem setRebateCodeStatusName(String value) { this.RebateCodeStatusName = value; return this; }
        public String getRebateCodeStatusDescription() { return RebateCodeStatusDescription; }
        public RebateCodeStatusItem setRebateCodeStatusDescription(String value) { this.RebateCodeStatusDescription = value; return this; }
    }

}

Java DeleteRebateCode DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /rebatecodes/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RebateCodeResponse 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>
  <Customers>
    <RebateCodeCustomerResponse>
      <Email>String</Email>
      <Firstname>String</Firstname>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ImageUrl>String</ImageUrl>
      <Lastname>String</Lastname>
      <Phone>String</Phone>
    </RebateCodeCustomerResponse>
  </Customers>
  <DaysOfWeek>
    <DaysOfWeekResponse>
      <DayOfWeek>String</DayOfWeek>
      <DayOfWeekActive>false</DayOfWeekActive>
      <DayOfWeekSortOrder>0</DayOfWeekSortOrder>
      <DayOfWeekTranslation>String</DayOfWeekTranslation>
      <Id>0</Id>
    </DaysOfWeekResponse>
  </DaysOfWeek>
  <FromTime>PT0S</FromTime>
  <Id>0</Id>
  <MaxNumberOfUses>0</MaxNumberOfUses>
  <MaxNumberOfUsesPerCustomer>0</MaxNumberOfUsesPerCustomer>
  <Name>String</Name>
  <NumberOfUsesPerCustomerUsed>0</NumberOfUsesPerCustomerUsed>
  <NumberOfUsesUsed>0</NumberOfUsesUsed>
  <PersonalNote>String</PersonalNote>
  <RebateCodeSign>String</RebateCodeSign>
  <RebateCodeStatusId>0</RebateCodeStatusId>
  <RebateCodeStatusOptions>
    <RebateCodeStatusResponse>
      <RebateCodeStatusItems>
        <RebateCodeStatusItem>
          <Id>0</Id>
          <RebateCodeStatusDescription>String</RebateCodeStatusDescription>
          <RebateCodeStatusName>String</RebateCodeStatusName>
        </RebateCodeStatusItem>
      </RebateCodeStatusItems>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
    </RebateCodeStatusResponse>
  </RebateCodeStatusOptions>
  <RebateCodeTypeId>0</RebateCodeTypeId>
  <RebateCodeTypesOptions>
    <RebateCodeTypeResponse>
      <RebateCodeTypeItems>
        <RebateCodeTypeItem>
          <Description>String</Description>
          <Id>0</Id>
          <Name>String</Name>
        </RebateCodeTypeItem>
      </RebateCodeTypeItems>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
    </RebateCodeTypeResponse>
  </RebateCodeTypesOptions>
  <RebateCodeValue>0</RebateCodeValue>
  <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>
  <Services>
    <RebateCodeServiceResponse>
      <Active>false</Active>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </RebateCodeServiceResponse>
  </Services>
  <StatusName>String</StatusName>
  <ToTime>PT0S</ToTime>
  <Updated>0001-01-01T00:00:00</Updated>
  <UpdatedBy>String</UpdatedBy>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</RebateCodeResponse>