ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Access

API	Description
GET Access/keepalive?deviceid[0]={deviceid[0]}&deviceid[1]={deviceid[1]}&localipaddress={localipaddress}	No documentation available.
GET Access/pass?deviceid={deviceid}&tagid={tagid}&datetime={datetime}&batch={batch}	No documentation available.

Activity

This class provides methods to get data about Activity.

API	Description
GET Activity/bybranch?branchid={branchid}	Gets data of all activities.
GET Activity/ecomm_get_free_booking?branchid={branchid}	Gets data of all activities enabled for booking in ecommerce.
GET Activity/ecomm_get_marketing?branchid={branchid}	Gets data of all activities which have marketing enabled.
GET Activity/single?id={id}	Gets data about an activity based on an id.

BaseDocumentTemplate

This class provides methods to get data about BaseDocumentTemplate model.

API	Description
GET BaseDocumentTemplate/bybranch?id={id}	Gets data of all base document template.
GET BaseDocumentTemplate/single?id={id}	Gets data about a base document template based on an id.

Branch

This class provides methods to get data about Branches.

API	Description
GET Branch/all	Gets data of all branches.
GET Branch/ecomm_all	Gets data of all branches enabled for the ecommerce.
GET Branch/ecomm_allbycustomer?id={id}	Gets data of all branches enabled for the ecommerce and linked to a customer.
GET Branch/single?id={id}	Gets data about a branch based on an id.

Cart

This class provides methods to get data about Carts.

API	Description
GET Cart/listrow	Gets data of cart rows based on a list of ids.
GET Cart/rowsbyobjectid?id={id}&customerid={customerid}	Gets data of cart rows based on an object id.

Classes

This class provides methods to get data about Classes.

API	Description
GET Classes/attendees?date={date}&classid={classid}	Gets the attendees of a class that have a booking for the selected date.
GET Classes/attendeesbranch?date={date}&branchid={branchid}	Gets attendees list of a certain data and branch
GET Classes/availability?id={id}	Checks the availability of a class.
GET Classes/ecomm_available_appointments?branchid={branchid}&customerid={customerid}&activityid={activityid}&startdate={startdate}&enddate={enddate}	Gets appointments list
GET Classes/ecomm_get_bookings?customerid={customerid}&startdate={startdate}&enddate={enddate}	Gets bookings list
POST Classes/ecomm_insert_booking?appointmentid={appointmentid}&customerid={customerid}	insert a booking
GET Classes/ecomm_planning?branchid={branchid}&startdate={startdate}&enddate={enddate}&customerid={customerid}	Gets appointments list
POST Classes/ecomm_remove_booking?appointmentid={appointmentid}&customerid={customerid}	Delete a booking
POST Classes/ecomm_remove_waitinglist?appointmentid={appointmentid}&customerid={customerid}	Remove a customer from the waiting list
POST Classes/ecomm_set_waitinglist?appointmentid={appointmentid}&customerid={customerid}	Insert a customer in the waiting list
GET Classes/ecomm_week_planning?branchid={branchid}	Gets appointments list
GET Classes/enrollments?classid={classid}	Gets enrollments list
GET Classes/single?id={id}	Gets data about a class based on an id.
GET Classes/single_season?id={id}	Gets data about a season based on an id.

CRM

This class provides methods to get data about Tasks.

API	Description
POST CRM/insertcollection	Insert a Task in CRM
POST CRM/insertgoaltype	Insert a new Goal Type
GET CRM/operationtypes?branchid={branchid}	Gets all the Operation Types of a branch

Customer

This class provides methods to get data about Customers.

API	Description
POST Customer/addCustomerToBranch	Inserts Customer To Branch
GET Customer/all?offset={offset}&length={length}&branch={branch}	Gets data of all Customers of a branch.
GET Customer/bybadge?badgeid={badgeid}	Gets data about a customer based on a badge id.
GET Customer/byname?offset={offset}&length={length}&name={name}	Gets Customers data filtered by name.
GET Customer/bysurname?offset={offset}&length={length}&surname={surname}&branchid={branchid}	Gets Customers data filtered by surname and branch id (optional).
GET Customer/createdafter?creationdatetime={creationdatetime}	Gets data about a customer created after a given date/time
POST Customer/findduplicates	Find customers who matches with given informations
GET Customer/GetImage?id={id}	Gets the image of a customer based on his id.
POST Customer/insert	Inserts a new Customer
GET Customer/listids	Gets customers data based on a list of ids.
GET Customer/modifiedafter?editdatetime={editdatetime}	Gets data about a customer modified after a given date/time
GET Customer/single?id={id}	Gets data about a customer based on an id.

Document

This class provides methods to get data about Documents.

API	Description
GET Document/bydateandbranch?start={start}&end={end}&idbranch={idbranch}	Gets data about documents created between two dates and filtered by branch.
GET Document/bydateandtemplate?start={start}&end={end}&idbasedocumenttemplate={idbasedocumenttemplate}	Gets data about documents created between two dates and filtered by document template.
GET Document/list	Gets data of documents based on a list of ids.
GET Document/single?id={id}	Gets data about a document based on an id.

DocumentTemplate

This class provides methods to get data about Document model.

API	Description
GET DocumentTemplate/single?id={id}	Gets data about a document template based on an id.

Entry

This class provides methods to get data about Sales.

API	Description
GET Entry/bybranch?branchid={branchid}&startDate={startDate}&endDate={endDate}&offset={offset}&length={length}	Gets the data of all the accesses in a specific branch
GET Entry/bycustomer?customerid={customerid}&startDate={startDate}&endDate={endDate}&offset={offset}&length={length}	Gets the data of all the accesses of a customer
GET Entry/bycustomer?customerid={customerid}&startDate={startDate}&endDate={endDate}&branchId={branchId}&offset={offset}&length={length}	Gets the data of all the accesses of a customer in an specific branch in a fix interval
GET Entry/byDate?startDate={startDate}&endDate={endDate}&branchId={branchId}&offset={offset}&length={length}	Gets the data of all the accesses in an specific branch in a fix interval
GET Entry/latest?totalEntries={totalEntries}&startDate={startDate}&branchid={branchid}	Gets the latest accesses in a specific branch

Klipfolio

API	Description
POST Klipfolio/Earning	No documentation available.
POST Klipfolio/Entries	No documentation available.

Membership

This class provides methods to get data about Membership.

API	Description
GET Membership/subscription?membershipid={membershipid}	Gets a subscription
GET Membership/subscription?branchid={branchid}&startdate={startdate}&enddate={enddate}	membership list between start and end dates

Message

This class provides methods to send messages.

API	Description
POST message/{ambiente}/sendEmail	Sends an email message
POST Message/sendEmail	Sends an email message

Multipacks

This class provides methods to get data about Multipacks.

API	Description
GET Multipacks/multipack?multipackid={multipackid}	Gets data about a multipack based on an id.
GET Multipacks/optionalrowsdescription?multipackid={multipackid}	Gets the description about all optional rows sold with a multipack
GET Multipacks/subscription?branchid={branchid}&startdate={startdate}&enddate={enddate}	Multipacks valids between two dates

Order

This class provides methods to get data about Orders.

API	Description
POST Order/create	Post data about a new Order.
POST Order/deleterow?orderrowid={orderrowid}	Delete an order row.

PaymentType

This class provides methods to get data about Payment type.

API	Description
GET PaymentType/single?id={id}	Gets data about a payment type based on an id.

ProShop

This class provides methods to get data about Items.

API	Description
GET ProShop/all_bybranch?offset={offset}&length={length}&branch={branch}&stocked={stocked}	Gets data of all items of a branch.
GET ProShop/availability?id={id}	Checks the availability of an item.
GET ProShop/countall_bybranch?branch={branch}&stocked={stocked}	Gets the number of items of a branch.
GET ProShop/itemavailability?id={id}&wID={wID}	Gets the availability of an item in a warehouse.
GET ProShop/list?stocked={stocked}	Gets data of items based on a list of ids.
GET ProShop/search?offset={offset}&length={length}&description={description}&code={code}&barcode={barcode}&branch={branch}&stocked={stocked}	Gets data of all items that suit some filters.
GET ProShop/single?id={id}	Gets data about an item based on an id.

Sales

This class provides methods to get data about Sales.

API	Description
GET Sales/all?startdate={startdate}&enddate={enddate}&branchid={branchid}	Gets data of all Sales of a branch and between two dates.
GET Sales/bycustomer?customerid={customerid}&offset={offset}&length={length}	Gets data of all the sales of a customer

API	Description
POST Social/deleteFriendship?customerid_1={customerid_1}&customerid_2={customerid_2}	delete a friendship
GET Social/findFriends?customerid={customerid}	Find other customer that this person could know.
GET Social/findFriends_byemail?customerid={customerid}&email={email}	Find other customer that this person could know.
GET Social/getActiveLessonInvitesSent?customerid={customerid}	get lesson invites sent
GET Social/getFriends?customerid={customerid}	get friends
GET Social/getFriendshipRequests?customerid={customerid}	get pending friendship requests
GET Social/getFriendsLessonInvite?customerid={customerid}&appointmentid={appointmentid}	Gets the invites to a lesson of a customer
GET Social/getPendingLessonInvitesReceived?customerid={customerid}	get pending lesson invites received
GET Social/getProfile?customerid={customerid}	Gets social profile information of a customer
POST Social/replyFriendshipRequest?requestid={requestid}&customerid={customerid}&accept={accept}	reply to a friendship request
POST Social/replyLessonInviteRequest?requestid={requestid}&customerid={customerid}&accept={accept}	reply to a lesson invite request
POST Social/requestFriendship?customerid={customerid}&recipientid={recipientid}	insert a friendship request
POST Social/sendLessonInvite?customerid={customerid}&recipientid={recipientid}&appointmentid={appointmentid}	insert a lesson invite request
POST Social/setProfile	Sets the social profile information to a customer

Tag

API	Description
GET Tag/bycategory?category={category}&branchid={branchid}	Gets data about tags based on category name.

TaxGroup

This class provides methods to get data about tax groups.

API	Description
GET TaxGroup/allbybranch?id={id}	Gets data of all tax groups linked to a branch.
GET TaxGroup/single?id={id}	Gets data about a tax group based on an id.

User

This class provides methods to get data about Users.

API	Description
POST User/addandlink	Adds a user and links it to a customer
GET User/allbybranch?branchid={branchid}	Gets data of all users linked to a branch.
GET User/checkexistinguser?username={username}	Check if user already exists.
GET User/employeesbybranch?branchid={branchid}	Gets data of all users linked to a branch.
GET User/login?username={username}&password={password}	Gets token of a user.
GET User/permissionvaluelist?id={id}&strperm={strperm}	Get's team permission's value.
GET User/single?id={id}	Gets data about a user based on an id.

Vending

Manages vending machines. ** INSTRUCTIONS FOR HASH PARAMETER ** hash parameter is the SHA-256 hash of the concatenation of the following strings: badgeIDDateTime: provided in sortable format: "yyyy-MM-ddTHH:mm:ss" (e.g. "2017-11-16T20:30:00" )Amount: provided in two decimal, dot separated, format (e.g. "20.00")VendingKey(secret) Example Given this JSON request: { "Amount":25.5 "BadgeId":"174095385909876039" "DateTime":"2017-12-04T12:00:00" "MachineId":"VENDING_MACH_01" "WalletId":165213695845083300 } and this vendingKey : 1234567890abcdef the string to hash is: "1740953859098760392017-12-04T12:00:0025.501234567890abcdef" the resulting hash will be: "7f9b336c75b15123a91e189ba72addd3d61e030fb10a366a2064ef0935c25e47"

API	Description
GET Vending/Balance?badgeID={badgeID}&walletID={walletID}	Retrieve the balance of the selected badge
POST Vending/Deduct?hash={hash}	Deduct amount from the selected badge
GET Vending/Info?badgeID={badgeID}	Retrieve info about the badgeID
POST Vending/Recharge?hash={hash}	Recharge the selected badge

Wallet

API	Description
POST Wallet/addcredit	Add credit to a wallet

Warehouse

This class provides methods to get data about Warehouses.

API	Description
GET Warehouse/allbybranch?id={id}	Gets data about a warehouse based on the id of a branch.
GET Warehouse/list	Gets data about warehouses based on a list of ids.
GET Warehouse/single?id={id}	Gets data about a warehouse based on an id.

Introduction

Access

Activity

BaseDocumentTemplate

Branch

Cart

Classes

CRM

Customer

Document

DocumentTemplate

Entry

Klipfolio

Membership

Message

Multipacks

Order

PaymentType

ProShop

Sales

Social

Tag

TaxGroup

User

Vending

Wallet

Warehouse