BokaMera.API.Host

<back to all web services

CreateRebateCode

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/rebatecodesCreate RebateCode.Create RebateCode.
CreateRebateCode Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?No
MaxNumberOfUsesbodyint?NoThe default value is 9999
MaxNumberOfUsesPerCustomerbodyint?NoThe default value is 1
ValidFrombodyDateTimeYes
ValidTobodyDateTimeYes
FromTimebodyTimeSpan?NoIf 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.
ToTimebodyTimeSpan?NoIf the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
RebateCodeTypeIdbodyintYes1 - Percent, 2 - Сurrency
RebateCodeValuebodyintYes
RebateCodeSignbodystringNoIf AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes
AutoGenerateRebateCodeSignbodyboolNoAutoGenerateRebateCodeSign=true - random generate code
PersonalNotebodystringNo
DaysOfWeekbodyList<int>No
ServicesbodyList<int>No
CustomersbodyList<Guid>No
RebateCodeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CompanyIdformGuid?No
ValidFromformDateTimeNo
ValidToformDateTimeNo
FromTimeformTimeSpanNoIf 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.
ToTimeformTimeSpanNoIf the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
CreatedByformstringNo
CreatedformDateTimeNo
UpdatedByformstringNo
UpdatedformDateTimeNo
PersonalNoteformstringNo
RebateCodeSignformstringNo
RebateCodeValueformintNo
RebateCodeTypeIdformintNo
NameformstringNo
RebateCodeStatusIdformintNo
StatusNameformstringNo
MaxNumberOfUsesformintNo
MaxNumberOfUsesPerCustomerformintNo
NumberOfUsesUsedformintNo
NumberOfUsesPerCustomerUsedformintNo
DaysOfWeekformList<DaysOfWeekResponse>No
ServicesformList<RebateCodeServiceResponse>No
CustomersformList<RebateCodeCustomerResponse>No
RebateCodeTypesOptionsformList<RebateCodeTypeResponse>No
RebateCodeStatusOptionsformList<RebateCodeStatusResponse>No
ResponseStatusformResponseStatusNo
DaysOfWeekResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DayOfWeekformstringNo
DayOfWeekTranslationformstringNo
DayOfWeekActiveformbool?No
DayOfWeekSortOrderformshort?No
RebateCodeServiceResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ActiveformboolNo
RebateCodeCustomerResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringNo
LastnameformstringNo
EmailformstringNo
PhoneformstringNo
ImageUrlformstringNo
RebateCodeTypeResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RebateCodeTypeItemsformList<RebateCodeTypeItem>No
RebateCodeTypeItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
RebateCodeStatusResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RebateCodeStatusItemsformList<RebateCodeStatusItem>No
RebateCodeStatusItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
RebateCodeStatusNameformstringNo
RebateCodeStatusDescriptionformstringNo

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

HTTP + CSV

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

POST /rebatecodes HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","MaxNumberOfUses":0,"MaxNumberOfUsesPerCustomer":0,"FromTime":"00:00:00","ToTime":"00:00:00","RebateCodeTypeId":0,"RebateCodeValue":0,"RebateCodeSign":"String","AutoGenerateRebateCodeSign":false,"PersonalNote":"String","DaysOfWeek":[0],"Services":[0],"Customers":["00000000-0000-0000-0000-000000000000"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"CompanyId":"00000000-0000-0000-0000-000000000000","FromTime":"00:00:00","ToTime":"00:00:00","CreatedBy":"String","UpdatedBy":"String","PersonalNote":"String","RebateCodeSign":"String","RebateCodeValue":0,"RebateCodeTypeId":0,"Name":"String","RebateCodeStatusId":0,"StatusName":"String","MaxNumberOfUses":0,"MaxNumberOfUsesPerCustomer":0,"NumberOfUsesUsed":0,"NumberOfUsesPerCustomerUsed":0,"DaysOfWeek":[{"Id":0,"DayOfWeek":"String","DayOfWeekTranslation":"String","DayOfWeekActive":false,"DayOfWeekSortOrder":0}],"Services":[{"Id":0,"Name":"String","Description":"String","Active":false}],"Customers":[{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","ImageUrl":"String"}],"RebateCodeTypesOptions":[{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"RebateCodeTypeItems":[{"Id":0,"Name":"String","Description":"String"}]}],"RebateCodeStatusOptions":[{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"RebateCodeStatusItems":[{"Id":0,"RebateCodeStatusName":"String","RebateCodeStatusDescription":"String"}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}