DataImport
| API | Description |
|---|---|
| GET api/DataImport/RefreshData |
No documentation available. |
| POST api/DataImport/CopyStyleToSubscriptions?from={from}&to={to}©CareSheetLogo={copyCareSheetLogo}©CareSheetsAds={copyCareSheetsAds} |
No documentation available. |
| POST api/DataImport/CopyIntegrationDataToSubscriptions?from={from}&to={to} |
No documentation available. |
| POST api/DataImport/ImportAccountSet?set={set} |
No documentation available. |
| POST api/DataImport/RecreateLabelFormats |
No documentation available. |
DataExport
| API | Description |
|---|---|
| GET api/DataExport/RefreshData?key={key}&blur={blur}&channel={channel}&recreateLabels={recreateLabels} |
No documentation available. |
Label
This API is used to provide all avilable labels(pets), create jpgs for a particular label or pdfs for the final composition (A4 or letter format with multiple labels). In addtion there it supports also the changes to the colors used for a lable, logo and calibration for the printer.
| API | Description |
|---|---|
| GET api/Label/AllPets?subscriptionID={subscriptionID}&excludeInternalBarcodes={excludeInternalBarcodes} |
Provides a list of available pets(labels) for a given subscription. |
| GET api/Label/Pet?subscriptionID={subscriptionID}&labelName={labelName}&petID={petID}&articleMappingEntryID={articleMappingEntryID} |
Get the full set of information for a pet. This might vary from label to label and therefore the labelname needs to be specified. The pet object is used be edited by the user if needed, send back to the server to generate the jpg or the final pdf. |
| GET api/Label/CustomLabelDefinition?subscriptionID={subscriptionID}&labelName={labelName} |
No documentation available. |
| GET api/Label/AllPetTypes?subscriptionID={subscriptionID} |
Used to get a list of all pettypes for UI filering |
| POST api/Label/CreateLabelAsJPG?subscriptionID={subscriptionID}&labelName={labelName} |
Create a jpg for a pet for a given label format. |
| POST api/Label/PrepareComposition?subscriptionID={subscriptionID}&labelName={labelName}&urlKey={urlKey} |
When the user has the final set of labels on the page he can request the final output to be generated as pdf |
| GET api/Label/LabelPDF/{urlKey} | |
| GET api/Label/LabelDefinitions?subscriptionID={subscriptionID} |
Get detailed information for the label definitions |
| POST api/Label/LabelSettings?subscriptionID={subscriptionID} |
No documentation available. |
| POST api/Label/LabelLogo?subscriptionID={subscriptionID}&labelName={labelName} |
Sets a logo for a lable type |
| GET api/Label/CalibrationPDF?subscriptionid={subscriptionid}&userid={userid} |
Downloads a pdf that should be printed. The user should fold the paper and read the number on the vertical and horizontal edge. When he enters this number any following pdf will be created with a offset. |
Integration
| API | Description |
|---|---|
| POST api/Integration/SendMail |
No documentation available. |
| POST api/Integration/WebHook |
No documentation available. |
CareSheet
This API provides all information to present a list of available CareSheets, request a pdf for them or print them directly to the cloud printer. In addition the Ads and the Logo for the caresheets can be managed over this API
Customer
The Customer controler is used to login and is the entry point for the user. It is also used to register new user (by users that have the permissions to manage users) and google cloud printers.
| API | Description |
|---|---|
| GET api/Customer/MyContext |
Used to get the list of all subscriptions that the user has access to. |
| POST api/Customer/RegisterUser |
Users that can manage "subusers" for one or multiple subscriptions can create new users. |
| POST api/Customer/ChangePasswordForUser |
No documentation available. |
| POST api/Customer/ChangePassword |
No documentation available. |
| POST api/Customer/ForgotPassword |
No documentation available. |
| GET api/Customer/AllUsers |
A user that can manage the users for a subscription can use this operation to get all users that have access to this subscriptions. |
| POST api/Customer/UpdateUserSettings |
No documentation available. |
| GET api/Customer/OrderManagementLink?subscriptionId={subscriptionId} |
No documentation available. |
| GET api/Customer/Manage?subscriptionId={subscriptionId}&bbci={bbci}&tck={tck} |
No documentation available. |
Article
Users can attach to a pet a set of information(barcode, internalcode, internalname or price). This is used if they want to have this informations prefilled or to used their own barcode printed on the lables instead of the petdata internal codes. It is important that one pet might have multiple entries like (goldfish small, goldfish big).
| API | Description |
|---|---|
| POST api/Article/AddArticleMapping | |
| POST api/Article/UpdateArticleMapping |
No documentation available. |
| POST api/Article/RemoveArticleMappings |
removes a mapping entry |
| GET api/Article/ExportPetArticleMappingsAsExcel?subscriptionID={subscriptionID}&key={key} |
Export the full list as an excel file. The user can use Excel to enter their mappings. Some of them are using it to automatically sync the prices with their databases. |
| POST api/Article/ImportPetArticleMappingsFromExcel?subscriptionID={subscriptionID} |
The eported list can be uploaded once the user has made some changes to the mapping. The server will than update the entries. |