| Requires the role: | superadmin |
| PUT | /superadmin/incentive/{id} | Update incentive |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@ValidateRequest(Validator="IsAuthenticated")
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public static class UpdateIncentive
{
/**
* The id of the incentive.
*/
@ApiMember(Description="The id of the incentive.", IsRequired=true, ParameterType="path")
public Integer Id = null;
@ApiMember()
public String Heading = null;
@ApiMember()
public String StorageUrl = null;
@ApiMember()
public String SuccessButtonText = null;
@ApiMember()
public Integer ActionId = null;
@ApiMember()
public IncentiveRecurrenceFrequency Frequency = null;
@ApiMember()
public Long RecurrenceInterval = null;
@ApiMember()
public Integer InitialDelayInSeconds = null;
@ApiMember()
public Integer MaxDisplayCount = null;
@ApiMember()
public Date ValidFrom = null;
@ApiMember()
public Date ValidTo = null;
@ApiMember()
public ArrayList<UUID> CompanyIds = null;
@ApiMember()
public ArrayList<IncentiveCriteriaDto> Criteria = null;
@ApiMember()
public String Payload = null;
public Integer getId() { return Id; }
public UpdateIncentive setId(Integer value) { this.Id = value; return this; }
public String getHeading() { return Heading; }
public UpdateIncentive setHeading(String value) { this.Heading = value; return this; }
public String getStorageUrl() { return StorageUrl; }
public UpdateIncentive setStorageUrl(String value) { this.StorageUrl = value; return this; }
public String getSuccessButtonText() { return SuccessButtonText; }
public UpdateIncentive setSuccessButtonText(String value) { this.SuccessButtonText = value; return this; }
public Integer getActionId() { return ActionId; }
public UpdateIncentive setActionId(Integer value) { this.ActionId = value; return this; }
public IncentiveRecurrenceFrequency getFrequency() { return Frequency; }
public UpdateIncentive setFrequency(IncentiveRecurrenceFrequency value) { this.Frequency = value; return this; }
public Long getRecurrenceInterval() { return RecurrenceInterval; }
public UpdateIncentive setRecurrenceInterval(Long value) { this.RecurrenceInterval = value; return this; }
public Integer getInitialDelayInSeconds() { return InitialDelayInSeconds; }
public UpdateIncentive setInitialDelayInSeconds(Integer value) { this.InitialDelayInSeconds = value; return this; }
public Integer getMaxDisplayCount() { return MaxDisplayCount; }
public UpdateIncentive setMaxDisplayCount(Integer value) { this.MaxDisplayCount = value; return this; }
public Date getValidFrom() { return ValidFrom; }
public UpdateIncentive setValidFrom(Date value) { this.ValidFrom = value; return this; }
public Date getValidTo() { return ValidTo; }
public UpdateIncentive setValidTo(Date value) { this.ValidTo = value; return this; }
public ArrayList<UUID> getCompanyIds() { return CompanyIds; }
public UpdateIncentive setCompanyIds(ArrayList<UUID> value) { this.CompanyIds = value; return this; }
public ArrayList<IncentiveCriteriaDto> getCriteria() { return Criteria; }
public UpdateIncentive setCriteria(ArrayList<IncentiveCriteriaDto> value) { this.Criteria = value; return this; }
public String getPayload() { return Payload; }
public UpdateIncentive setPayload(String value) { this.Payload = value; return this; }
}
public static enum IncentiveRecurrenceFrequency
{
OneTime(1),
Weekly(2),
Monthly(3);
private final int value;
IncentiveRecurrenceFrequency(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static class IncentiveCriteriaDto
{
public CriteriaType CriteriaType = null;
public String Value = null;
public Boolean InvertCondition = null;
public CriteriaType getCriteriaType() { return CriteriaType; }
public IncentiveCriteriaDto setCriteriaType(CriteriaType value) { this.CriteriaType = value; return this; }
public String getValue() { return Value; }
public IncentiveCriteriaDto setValue(String value) { this.Value = value; return this; }
public Boolean isInvertCondition() { return InvertCondition; }
public IncentiveCriteriaDto setInvertCondition(Boolean value) { this.InvertCondition = value; return this; }
}
public static enum CriteriaType
{
LicenseAvailability,
SmsActivation,
EAccountingActivation,
CodeLockActivation,
SocialActivation,
OnlinePaymentActivation,
FollowUpMessageActivation,
RatingActivation;
}
public static class AdminIncentiveQueryResponse extends CompanyIncentiveResponse
{
public IncentiveRecurrenceFrequency Frequency = null;
public Long RecurrenceInterval = null;
public Date CreatedDate = null;
public Date ModifiedDate = null;
public ArrayList<UUID> CompanyIds = null;
public ArrayList<IncentiveCriteria> Criteria = null;
public Boolean ApplyToAllCompanies = null;
public IncentiveRecurrenceFrequency getFrequency() { return Frequency; }
public AdminIncentiveQueryResponse setFrequency(IncentiveRecurrenceFrequency value) { this.Frequency = value; return this; }
public Long getRecurrenceInterval() { return RecurrenceInterval; }
public AdminIncentiveQueryResponse setRecurrenceInterval(Long value) { this.RecurrenceInterval = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public AdminIncentiveQueryResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public AdminIncentiveQueryResponse setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public ArrayList<UUID> getCompanyIds() { return CompanyIds; }
public AdminIncentiveQueryResponse setCompanyIds(ArrayList<UUID> value) { this.CompanyIds = value; return this; }
public ArrayList<IncentiveCriteria> getCriteria() { return Criteria; }
public AdminIncentiveQueryResponse setCriteria(ArrayList<IncentiveCriteria> value) { this.Criteria = value; return this; }
public Boolean isApplyToAllCompanies() { return ApplyToAllCompanies; }
public AdminIncentiveQueryResponse setApplyToAllCompanies(Boolean value) { this.ApplyToAllCompanies = value; return this; }
}
public static class CompanyIncentiveResponse
{
public Integer Id = null;
public String Heading = null;
public String StorageUrl = null;
public String SuccessButtonText = null;
public Integer ActionId = null;
public Integer InitialDelayInSeconds = null;
public Integer MaxDisplayCount = null;
public Date ValidFrom = null;
public Date ValidTo = null;
public IncentiveActionResponse Action = null;
public String Payload = null;
public Integer getId() { return Id; }
public CompanyIncentiveResponse setId(Integer value) { this.Id = value; return this; }
public String getHeading() { return Heading; }
public CompanyIncentiveResponse setHeading(String value) { this.Heading = value; return this; }
public String getStorageUrl() { return StorageUrl; }
public CompanyIncentiveResponse setStorageUrl(String value) { this.StorageUrl = value; return this; }
public String getSuccessButtonText() { return SuccessButtonText; }
public CompanyIncentiveResponse setSuccessButtonText(String value) { this.SuccessButtonText = value; return this; }
public Integer getActionId() { return ActionId; }
public CompanyIncentiveResponse setActionId(Integer value) { this.ActionId = value; return this; }
public Integer getInitialDelayInSeconds() { return InitialDelayInSeconds; }
public CompanyIncentiveResponse setInitialDelayInSeconds(Integer value) { this.InitialDelayInSeconds = value; return this; }
public Integer getMaxDisplayCount() { return MaxDisplayCount; }
public CompanyIncentiveResponse setMaxDisplayCount(Integer value) { this.MaxDisplayCount = value; return this; }
public Date getValidFrom() { return ValidFrom; }
public CompanyIncentiveResponse setValidFrom(Date value) { this.ValidFrom = value; return this; }
public Date getValidTo() { return ValidTo; }
public CompanyIncentiveResponse setValidTo(Date value) { this.ValidTo = value; return this; }
public IncentiveActionResponse getAction() { return Action; }
public CompanyIncentiveResponse setAction(IncentiveActionResponse value) { this.Action = value; return this; }
public String getPayload() { return Payload; }
public CompanyIncentiveResponse setPayload(String value) { this.Payload = value; return this; }
}
public static class IncentiveActionResponse
{
public Integer Id = null;
public IncentiveActionType ActionType = null;
public String Page = null;
public String Segment = null;
public String Element = null;
public Integer LicenseTypeId = null;
public LicenseTypeQueryResponse SuggestedLicenseToUpgrade = null;
public Integer getId() { return Id; }
public IncentiveActionResponse setId(Integer value) { this.Id = value; return this; }
public IncentiveActionType getActionType() { return ActionType; }
public IncentiveActionResponse setActionType(IncentiveActionType value) { this.ActionType = value; return this; }
public String getPage() { return Page; }
public IncentiveActionResponse setPage(String value) { this.Page = value; return this; }
public String getSegment() { return Segment; }
public IncentiveActionResponse setSegment(String value) { this.Segment = value; return this; }
public String getElement() { return Element; }
public IncentiveActionResponse setElement(String value) { this.Element = value; return this; }
public Integer getLicenseTypeId() { return LicenseTypeId; }
public IncentiveActionResponse setLicenseTypeId(Integer value) { this.LicenseTypeId = value; return this; }
public LicenseTypeQueryResponse getSuggestedLicenseToUpgrade() { return SuggestedLicenseToUpgrade; }
public IncentiveActionResponse setSuggestedLicenseToUpgrade(LicenseTypeQueryResponse value) { this.SuggestedLicenseToUpgrade = value; return this; }
}
public static enum IncentiveActionType
{
Upgrade(1),
AddOn(2),
Information(3);
private final int value;
IncentiveActionType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static class LicenseTypeQueryResponse
{
/**
* The license type id
*/
@ApiMember(Description="The license type id")
public Integer Id = null;
/**
* The license type name
*/
@ApiMember(Description="The license type name")
public String Name = null;
/**
* The license type description
*/
@ApiMember(Description="The license type description")
public String Description = null;
/**
* If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
*/
@ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.")
public Boolean IsExtraLicenseOption = null;
/**
* The period of notice for the license in days.
*/
@ApiMember(Description="The period of notice for the license in days.")
public Integer PeriodOfNoticeDays = null;
/**
* The license items for the license type
*/
@ApiMember(Description="The license items for the license type")
public ArrayList<LicenseItemsResponse> Items = null;
/**
* The license prices in each country for the license type
*/
@ApiMember(Description="The license prices in each country for the license type")
public ArrayList<LicensePriceResponse> Prices = null;
public Integer getId() { return Id; }
public LicenseTypeQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public LicenseTypeQueryResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public LicenseTypeQueryResponse setDescription(String value) { this.Description = value; return this; }
public Boolean getIsExtraLicenseOption() { return IsExtraLicenseOption; }
public LicenseTypeQueryResponse setIsExtraLicenseOption(Boolean value) { this.IsExtraLicenseOption = value; return this; }
public Integer getPeriodOfNoticeDays() { return PeriodOfNoticeDays; }
public LicenseTypeQueryResponse setPeriodOfNoticeDays(Integer value) { this.PeriodOfNoticeDays = value; return this; }
public ArrayList<LicenseItemsResponse> getItems() { return Items; }
public LicenseTypeQueryResponse setItems(ArrayList<LicenseItemsResponse> value) { this.Items = value; return this; }
public ArrayList<LicensePriceResponse> getPrices() { return Prices; }
public LicenseTypeQueryResponse setPrices(ArrayList<LicensePriceResponse> value) { this.Prices = value; return this; }
}
public static class LicenseItemsResponse
{
public Integer Id = null;
public String Name = null;
public Integer AllowedItems = null;
public Integer getId() { return Id; }
public LicenseItemsResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public LicenseItemsResponse setName(String value) { this.Name = value; return this; }
public Integer getAllowedItems() { return AllowedItems; }
public LicenseItemsResponse setAllowedItems(Integer value) { this.AllowedItems = value; return this; }
}
public static class LicensePriceResponse
{
public Integer LicenseTypeId = null;
public String CountryId = null;
public Integer Price = null;
public Country Country = null;
public Integer LicensePlanId = null;
public Integer getLicenseTypeId() { return LicenseTypeId; }
public LicensePriceResponse setLicenseTypeId(Integer value) { this.LicenseTypeId = value; return this; }
public String getCountryId() { return CountryId; }
public LicensePriceResponse setCountryId(String value) { this.CountryId = value; return this; }
public Integer getPrice() { return Price; }
public LicensePriceResponse setPrice(Integer value) { this.Price = value; return this; }
public Country getCountry() { return Country; }
public LicensePriceResponse setCountry(Country value) { this.Country = value; return this; }
public Integer getLicensePlanId() { return LicensePlanId; }
public LicensePriceResponse setLicensePlanId(Integer value) { this.LicensePlanId = value; return this; }
}
public static class Country extends BaseModel
{
@References(Currency.class)
public String CurrencyId = null;
public Currency CurrencyInfo = null;
@Required()
public String Name = null;
public String Culture = null;
public String TimeZone = null;
public Date ModifiedDate = null;
@Required()
public String Id = null;
public String getCurrencyId() { return CurrencyId; }
public Country setCurrencyId(String value) { this.CurrencyId = value; return this; }
public Currency getCurrencyInfo() { return CurrencyInfo; }
public Country setCurrencyInfo(Currency value) { this.CurrencyInfo = value; return this; }
public String getName() { return Name; }
public Country setName(String value) { this.Name = value; return this; }
public String getCulture() { return Culture; }
public Country setCulture(String value) { this.Culture = value; return this; }
public String getTimeZone() { return TimeZone; }
public Country setTimeZone(String value) { this.TimeZone = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public Country setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getId() { return Id; }
public Country setId(String value) { this.Id = value; return this; }
}
public static class BaseModel
{
}
public static class Currency extends BaseModel
{
@Required()
public String Name = null;
@Required()
public String CurrencySign = null;
@Required()
public Boolean Active = null;
public Date ModifiedDate = null;
@Required()
public String Id = null;
public String getName() { return Name; }
public Currency setName(String value) { this.Name = value; return this; }
public String getCurrencySign() { return CurrencySign; }
public Currency setCurrencySign(String value) { this.CurrencySign = value; return this; }
public Boolean isActive() { return Active; }
public Currency setActive(Boolean value) { this.Active = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public Currency setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getId() { return Id; }
public Currency setId(String value) { this.Id = value; return this; }
}
public static class IncentiveCriteria extends BaseModel
{
public Integer Id = null;
public Integer IncentiveId = null;
public CriteriaType CriteriaType = null;
public String Value = null;
public Boolean InvertCondition = null;
public Date CreatedDate = null;
public Integer getId() { return Id; }
public IncentiveCriteria setId(Integer value) { this.Id = value; return this; }
public Integer getIncentiveId() { return IncentiveId; }
public IncentiveCriteria setIncentiveId(Integer value) { this.IncentiveId = value; return this; }
public CriteriaType getCriteriaType() { return CriteriaType; }
public IncentiveCriteria setCriteriaType(CriteriaType value) { this.CriteriaType = value; return this; }
public String getValue() { return Value; }
public IncentiveCriteria setValue(String value) { this.Value = value; return this; }
public Boolean isInvertCondition() { return InvertCondition; }
public IncentiveCriteria setInvertCondition(Boolean value) { this.InvertCondition = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public IncentiveCriteria setCreatedDate(Date value) { this.CreatedDate = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /superadmin/incentive/{id} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Id":0,"Heading":"String","StorageUrl":"String","SuccessButtonText":"String","ActionId":0,"Frequency":"OneTime","RecurrenceInterval":0,"InitialDelayInSeconds":0,"MaxDisplayCount":0,"ValidFrom":"0001-01-01T00:00:00.0000000+00:00","ValidTo":"0001-01-01T00:00:00.0000000+00:00","CompanyIds":["00000000-0000-0000-0000-000000000000"],"Criteria":[{"CriteriaType":"LicenseAvailability","Value":"String","InvertCondition":false}],"Payload":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Frequency":"OneTime","RecurrenceInterval":0,"CreatedDate":"0001-01-01T00:00:00.0000000+00:00","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","CompanyIds":["00000000-0000-0000-0000-000000000000"],"Criteria":[{"Id":0,"IncentiveId":0,"CriteriaType":"LicenseAvailability","Value":"String","InvertCondition":false,"CreatedDate":"0001-01-01T00:00:00.0000000+00:00"}],"ApplyToAllCompanies":false,"Id":0,"Heading":"String","StorageUrl":"String","SuccessButtonText":"String","ActionId":0,"InitialDelayInSeconds":0,"MaxDisplayCount":0,"ValidFrom":"0001-01-01T00:00:00.0000000+00:00","ValidTo":"0001-01-01T00:00:00.0000000+00:00","Action":{"Id":0,"ActionType":"Upgrade","Page":"String","Segment":"String","Element":"String","LicenseTypeId":0,"SuggestedLicenseToUpgrade":{"Id":0,"Name":"String","Description":"String","IsExtraLicenseOption":false,"PeriodOfNoticeDays":0,"Items":[{"Id":0,"Name":"String","AllowedItems":0}],"Prices":[{"LicenseTypeId":0,"CountryId":"String","Price":0,"Country":{"CurrencyId":"String","CurrencyInfo":{"Name":"String","CurrencySign":"String","Active":false,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"Name":"String","Culture":"String","TimeZone":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"LicensePlanId":0}]}},"Payload":"String"}