This resource page details how the Breeze Dataserver can be used to share information with client applications and the inventory management system. This guide is arranged with each available endpoint linked on the sidebar and within each endpoint page related Reference Documentation and set of Tabs displaying:
Contact Support: \n{
\nName : Datapel Systems
\nEmail : support@datapel.com
\n}
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8782203","collectionId":"830542bb-d7bd-49bf-8937-14fc9d293a9e","publishedId":"SVmsWLSu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-09-13T05:19:59.000Z"},"item":[{"name":"How It Works","item":[],"id":"cc4355ce-664e-4f58-aff3-895cb6d5d698","description":"The Breeze API is a REST/SOAP server and responds to HTTP Web requests with XML or JSON formatted responses. The Breeze server works with HTTP GET and POST methods and each endpoint will respond differently based on its specification. Typically GET is used to retrieve a Dataset from a resource while POST is used to push or INSERT/UPDATE a Dataset to the server.
\nThe HTTP request has THREE basic components as below:
\n| HTTP part | \nDescription | \nUsed by Breeze Server | \n
| Header | \nContains details regarding the format of the message | \nOptional Credentials | \n
| URL | \nThe destination resource or endpoint and additional parameters | \nRequired for endpoint identification | \n
| Message Body | \nAn optional message body e.g. file, query data, or query result | \nOptional POST details | \n
In order to request information from an endpoint the Breeze server will respond to the GET method and returns information in the message body as json or xml depending on the URL. It is possible to push information to some endpoint resources using the GET method if data is accepted via the parameters passed in the URL. Check specific Endpoint references to see if this method is supported. An example URL is shown below:
\nhttp://api.datapel.com:8080/xml/ENDPOINT?myfilterstring&authorization~code&auth_token=token
\nIn order to insert or update information to an endpoint the Breeze server responds to the POST method and returns status information in the message body. Typically the information being sent to the endpoint is carried in the message body however most endpoints support the passing of small datasets via the URL as a single parameter. Specific restrictions depend on the endpoint functionality, generally the raw dataset can be passed via the URL if not otherwise specified.
\nThe Breeze server has a predefined structure for the POST REQUEST message body as below:
\n<?xml version=\"1.0\" encoding=\"utf-16\"?> \n <PostRequest xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">\n <updatetype>Insert</updatetype> \n <filter /> \n <updateObject xsi:type=\"xsd:string\">{\"JsonOrXML\":true}</updateObject> \n </PostRequest>\n| Property | \nDescription | \nExample | \n
| UpdateType | \nEither INSERT/UPDATE/DELETE/QUERY | \nINSERT | \n
| Filter | \nA valid filter criteria using properties and operators | \nfilter~basestockid=5 | \n
| UpdateObject | \nJSON or XML encoded Dataset | \n<see endpoint POST samples>* | \n
To manage access to your workspace all information requests must present credentials to be authenticated by the Breeze Data Server.
\nAuthentication Workflow
\nIn order to access the Data Server you must have an API Username and Password. The master API Username and \nPassword will be configured by your system administrator within your Breeze Data Server config.xml file. The Authentication process works as follows:
\nProviding security credentials can be done in one of two ways:
\n- Encoding Authorisation information in the HTTP header (or)\n- Passing Authorisation token keys in the URL\nThe Breeze Data Server can be configured to operate over HTTP or HTTPS (SSL).
\nWith HTTPS the information transmitted from sender to receiver is encrypted and is the most secure method of ensuring data transmitted will not be decrypted or tampered with. In order to use HTTPS you will require an SSL Certificate and this usually relates to the domain name from where the server is referenced, for example: api.datapel.com. You will need to install the certificate on the physical operating system hosting the Breeze Data Server.
\nTo specify HTTP or HTTPS you must setup in the Breeze Data Server config.xml and ensure the service is restarted for changes to come into effect.
\nEvery request for Breeze Data Server resources must contain the following attributes in the header.
\n| Field | \nDescription | \nExample | \n
| Content-Type | \nMIME type of the request body. | \napplication/xml | \n
| Host | \nThe host for handling request; Data Server host name. | \napi.datapel.com | \n
| Accept-Encoding | \nEnables encoding of the request. | \ngzip,deflate | \n
Optional Additional Header Security attributes:
\n| Field | \nDescription | \nExample | \n
| Authorization | \nRequired parameter for authorising the request. | \nSee below - Authorization | \n
| Auth_Token | \nRequired parameter issued for your session by serever. | \nSee below - Authorization | \n
In addition to (or instead of) the above Request Header encoding the session token and authorisation key can be passed directly via the URL as parameters.
\n- The URL must take on the standard form of /type(json/xml)/endpoint?filter~filterstring\n- Credentials must then be APPENDED to URL for example: http://.../endpoint/filter~&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA\nAn example detailing URL security encoding is shown below.
\nURL encoding Authorisation Example
\nThe following example describes the HTTP GET query for obtaining a SESSION TOKEN and then making an endpoint request.
\nFirst you are required to create the Authorization key from base64 encoded master api Username and Passord in the following form:
\n- Authorization Key = UrlEncode(Encode_Base64(Username + \":\" + Password)). For more information on base64 see https://www.base64encode.org\n- Assuming master api username:password pair of \"superuser:password\" generates the Authorization Key = c3VwZXJ1c2VyOnBhc3N3b3Jk\n- To get the session token:\n\nhttp://api.datapel.com:8080/json/token?authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk\n\nReturns a session token as below: \n [\n {\n \"token\": \"oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA\" \n }\n ]\n\n- You may now use the credentials in the URL or HEADER to perform GET/POST requests to service endpoints.\n\n Example: GET current api timestamp with URL authorization\n \n http://api.datapel.com:8080/json/timestamp?filter~&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA\n \n Returns a response as below: \n {\n \"ServerTimeStamp\": \"2014-11-04 20:23:51\" \n }\n \n- For all future ENDPOINT requests your URL must be in the following form....\n\n http://api.datapel.com:8080/json/ENDPOINT?myfilterstring&authorization~url_encoded_base64(user:pass)&auth_token=url_encoded_server_access_token\n\n- Tokens must be refreshed within 24 hours or they will be rejected so it is recommended that a daily task of refreshing the session token be added to your system design.\n- Always make sure the token is URL ENCODED before encoding the entire URL otherwise because base64 contains characters like + etc that will be decoded on the server side and cause authentication to fail.\nWhen requesting a dataset from an endpoint a criteria filter can be set to limit the number of results or find a specific record subset. Generally the parameters are limited to the properties of the dataset. This reference shows the valid parameters for each endpoint resource under the Paramters tab.
\nMultiple parameters can be combined to produce a logical criteria however there are restrictions on the syntax and only a limited set of operators are valid as below:
\n| Operator | \nDescription | \nExample | \n
| = | \nEqual to | \nitemname = 'Jacket' | \n
| <> | \nNot Equal to | \nquantity <> 0 | \n
| >, <, | \nGreater than/Less than | \naccountbalance > 0 | \n
| >=, <=, | \nGreater or Equal/Less or Equal | \nbasestockid >=20 | \n
| in () | \nparameter in set | \nbasestockid in (5,6,7,10,50) | \n
| AND | \nrequired criteria | \ncolour='blue' and quantity>0 | \n
| OR | \noptional criteria | \nudf1='dealeronly' or udf='promo' | \n
The endpoint URL must always begin with filter~. Brackets are not support and may cause incorrect results - for example:
\nfilter~(itemname='Jacket' AND colour='blue') OR udf1=\"pants\"
\nWill NOT work under the current criteria parser and returns: 500 Query filter could not be parsed.
\nIf you require complex criteria contact Datapel technical support for suggestions on how best to manage these via the Breeze API.\n
The Breeze Dataserver API has two very distinct configuration options as described below:
\n- OnPremise : In this case the Breeze API server is installed locally on the customer server or same local network as the SQL Server instance and Datapel application software - this configuration is termed \"On Premise\". In this configuration any changes made by users are immediately accessible to the Breeze Dataserver - and any posted sales can be reviewed in real-time.\n\n- CloudMirror : The Datapel Public Cloud is a high performance internet server with the latest Breeze Dataserver API server. You will be allocated a public URL that references your companies Cloud Services. For example http://OurCompany.datapel.net. In this configuration any information from your on premise Datapel application is \"mirrored\" to the cloud server on a periodic basis, typically every 5 - 15 minutes. This configuration is preferable as your \"On Premise\" server is protected from public access via the internet. Generally the Datapel Cloud Mirror Service communicates with your On Premise Datapel application via SSL connection that can be IP Address authenticated - thereby securing your connection, server and master database. As the CloudMirror is just a copy of your server public attacks on this server will not impact the local on premise operations or system data integrity. As the CloudMirror requires relaying of information there is a 5 - 15 minute lag between the real-time system and the cloud data view. In most cases this is easily managed by establishing stock buffers or isolating \"online\" vs \"onpremise\" operations using system defined Locations.\nTo ensure a RESPONSIVE design the REST interface should not introduce long DELAYS while data is being served from an endpoint query. It is generally bad practice to select an excessive number of records in a single query as a large volume of data will cause your web page and the breeze server to appear \"lockedup\" while it processes and returns the raw data.
\nWhere possible data derived from long lists should be \"paged\" and retrieved as datasets with each block representing a number of records. The number of records to read will depend on the number and size of properties being returned from the endpoint. In general you determine the page size based on the expected BANDWIDTH of the connection you have between the client browser / application and the Breeze Dataserver.
\nFor example you may have a typical internet connection (ADSL) 1MB/s equivalent to approximately 128kb/s. It will take approximately 1 second to download 128k of information so using the ITEMS endpoint a typical JSON record can require about 2k per item master record. If your dataset has 5000 items then to read ALL RECORDS the response time would be around 78 seconds or 1 minute / 18 seconds to download. So presenting a new item list in real-time direct from the server is not practical. In reality a remote \"copy\" of the item master list would be held at the web server/remote application - and ideally only changes would be updated directly from the data server on demand or as they happen.
\nIf your application and Dataserver are hosted on the same physical machine or local network then transfer rates would be much higher and result sets transferred in under 1 second - making live access to data feasible. So the use of paged datasets needs to be part of your design planning.
\nUsing TimeStamp Endpoint and Property as Changed Record Trigger
\nTo assist in minimising the amount of redundant information being transferred between the client application and server the TIMESTAMP endpoint and a TIMESTAMP property is available for most ENDPOINT query resources. Typically the workflow for obtaining ONLY changed records is as follows:
\n1. Start list update\n2. Authenicate Connection\n3. Get Server TIMESTAMP as NEW-TIMESTAMP\n4. Read Endpoint with ?FILTER~TIMESTAMP > 'LASTACCESSED-TIMESTAMP'\n5. Update local client / app records\n6. LASTACCESSED-TIMESTAMP = NEW-TIMESTAMP\n7. Wait a fixed period of time or on demand for resource loop to start\nBy following this general endpoint query pattern the resulting dataset will always return just the records that have changed after the last endpoint read hence minimising the amount of data being transferred from the Dataserver to the browser/client application. This approach assumes you have an existing list inplace - if not the first pass will return ALL records from the endpoint resource as the TimeStamp would be NULL.\n
When working with large data sets it is useful to return partial result sets. This technique is commonly referred to as response PAGING. Endpoints that support PAGING will have the PAGING tag on the endpoint verbs bar within the \"Try It\" pages. The default pageSize is 500 records and can be adjusted in the DataServer configuration management panel. This example shows a pageSize = 100 records.
\nUse the WITH PAGING hint to enable page referencing of partial data sets as shown below:
\nhttp://api.datapel.com:8080/JSON/sql?filter~SELECT * FROM BST_BaseStock WITH PAGING
\nResponse result set will now contain a transaction cacheid reference and always returns the first page of results:
\n \"Status\": \"OK\",\n \"cacheid\": \"ca79e867-36dd-47fc-8113-2c70f7c73653\",\n \"RowChanges\": \"100\",\n \"PageNumber\": \"1\",\n \"RowTotal\": \"198\" \n \nBy specifying the WITH PAGING hint further pages can be requested using the cacheid reference as shown below.
\nUse the WITH PAGING ON cacheid PAGE XX to return the relevant page number from the initial data set.
\nhttp://api.datapel.com:8080/JSON/itemslist?filter~* WITH PAGING ON ca79e867-36dd-47fc-8113-2c70f7c73653 PAGE 2
\nResponse result set will contain the cacheid reference:
\n \"Status\": \"OK\",\n \"cacheid\": \"ca79e867-36dd-47fc-8113-2c70f7c73653\",\n \"RowChanges\": \"98\",\n \"PageNumber\": \"2\",\n \"RowTotal\": \"198\" \n \nIf the page number contains no records an EMPTY response will result.\n
Paging is not supported on all endpoints via the Breeze Dataserver and may require implementation via a client side run of queries. Where this is required it should be implemented as per the example shown below. In this case you require an indexing column against which the dataset will be sorted.
\nIn order to complete the query you should maintain a @PAGE_SIZE being the number of records per page and the @PAGE_NUMBER being the offset into the dataset that you require. In the example below we show the main Item Master table and use the Item Master ID as the ASCENDING index.
\nSELECT * FROM BST_BaseStock WHERE BST_ID IN \n (SELECT TOP @PAGE_SIZE BST_ID FROM BST_BaseStock WHERE BST_ID NOT IN \n (SELECT TOP @PAGE_SIZE*(@PAGE_NUMBER-1) BST_ID FROM BST_BaseStock ORDER BY BST_ID) \nORDER BY BST_ID) ORDER BY BST_ID
\nIn the below example we retrieve all Item Details with the PAGE_SIZE = 20 and are requesting PAGE_NUMBER=3. Note Security URL parameters are omitted for clarity.
\nhttp://api.datapel.com:8080/JSON/sql?filter~SELECT * FROM BST_BaseStock WHERE BST_ID IN \n (SELECT TOP 20 BST_ID FROM BST_BaseStock WHERE BST_ID NOT IN \n (SELECT TOP 40 BST_ID FROM BST_BaseStock ORDER BY BST_ID) ORDER BY BST_ID) ORDER BY BST_ID
\nWhen possible please use the built in Paging Hints as these hints remove dependencies on primary key index fields and will improve backward compatibility of your client application with future DataServer releases.
\nIn order to maximise performance of the Breeze Dataserver a number of endpoints support server side caching and the Datapel DIFFX engine. The DIFFX engine allows the caller to reference a previous transaction and request ONLY THE DIFFERENCES. This can dramatically improve the response times of your client application. Endpoints that support the DIFFX engine will have the DIFFX tag on the endpoint verbs bar within the \"Try It\" pages.
\nUse the WITH CACHE hint to create a server-side response copy as shown below:
\nhttp://api.datapel.com:8080/JSON/itemslist?filter~* WITH CACHE\n
\nResponse result set will now contain a transaction cacheid reference:
\"cacheid\": \"8af515f5-c786-49cd-a179-edd250cf0207\"\nUse the WITH DIFF ON cacheid to return only data changes since between the request responses.
\nhttp://api.datapel.com:8080/JSON/itemslist?filter~* WITH DIFF ON 8af515f5-c786-49cd-a179-edd250cf0207\n
\nResponse result set will contain a NEW transaction cacheid reference:
\"cacheid\": \"0aee6203-d0e1-4b5f-8eca-80775de787e1\" \nIf no changes have occurred then an EMPTY response will result - continue to use the existing cacheid and WITH DIFF hint.
\nDIFFX Cache Persistence
\nThe DIFFX response cache typically remains for 3-5 days after the initial cache event. Any DIFF ON hints that return a difference will create a new cache entry. Generally you should always use the latest cacheid from the most recent response. There is no limit to the number or size of cache requests you can make.
\nKeep in mind that using DIFFX adds more load to the DataServer as it persists more response information and adds overhead to the processing of a response while it processes the differences between current and previous response messages. Generally the response size is reduced to 10-20% compared to standard response messages when using DIFFX hints. Furthermore, the more frequent the requests the smaller the responses tend to be.
\nIf the cacheid DOES NOT EXIST the server will just return the full response, automatically cache the data and return a new valid cacheid. Generally there is little risk of \"missing\" data changes due to server side cache expiration.\n
Generally as the Breeze Dataserver is upgraded the endpoint resources will return properties that are backward compatible with previous versions. This allows client applications to remain unchanged as the inventory management system and Breeze Dataserver improve and are upgraded. In some cases however functionality of a specific endpoint may need to change dramatically and potentially cause existing applications to break as returned information or filters are no longer valid.
\nTo minimise the work required by third parties to maintain compatibility with Breeze Dataserver the endpoint interface supports a VERSION path. This allows an external application to bind directly to a specific version of an ENDPOINT so the QUERY response complies with return properties consistent with the API version that the client application was developed against. Endpoint versions will be published direct to developers as and when specification and requirement change dictates endpoint versioning.
\nAt all times the default endpoint will support the latest functionality for the Breeze Dataserver.
\n- To access a specific ENDPOINT version the request URL must be in the following form....\n\nhttp://api.datapel.com:8080/json/vX/ENDPOINT?filter~myfilterstring&authorization~base64(user:pass)&auth_token=server_access_token\n\nWHERE vX is v1, v2, v3 etc the version provided by Datapel required to support your client application interface.\n\nThe older the application the lower the version number; v1 would be the oldest deprecated endpoint version.\nPOST as with the READ/GET process from the API needs to ensure RESPONSIVE design and not incur DELAYS while data is processed or consumed by an endpoint service. In the case of pushing transaction information via Breeze API there are currently two methods available:
\n- The \"in process\" ORDER POST (sales endpoint) or\n- QUEUED POST of an ORDER (salesqueue endpoint)\n- \nThe \"in process\" option will attempt to commit the transaction immediately and any exceptions will be sent back via the API requiring the client to handle the response. The QUEUED POST pushes the order into a list of orders that will be processed by the server as part of a batch or to be initiated by a local administrator or administrator process. Furthermore the QUEUE can be cleared or FLUSHED via the API and forces the server to consume the posted orders.
\nCurrently we are recommending that Sale Orders be POSTED via the SalesQueue Endpoint and triggered for processing on the server-side using a SalesQueueCount&FLUSH query with the appended FLUSH parameter as shown.
\n- POST sale xml to the salequeue endpoint as: \nhttp://api.datapel.com:8080/xml/salesqueue?filter~&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA\n- Valid Response will be a QID code: e.g. QID-1234-5678\n- GET sale queue count with Flush to commit orders as:\nhttp://api.datapel.com:8080/xml/salesqueuecount?filter~FLUSH&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA\n\nNOTE: Flush is not required when working with CLOUD MIRROR configurations - flush will occur automatically based on cloud mirror cycle time. \n- Check order status using GET status endpoint.\nIf you supplied the invoice number you can use this as search field:\n\nhttp://api.datapel.com:8080/xml/status?filter~invoicenum='remoteinvoicenum'&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA\n\nIt is recommended the QID is used to reference the transaction as shown below:\n\nhttp://api.datapel.com:8080/xml/status?filter~qid='QID-1234-5678'&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA\nNote that there maybe some delay between the sale queue flush and the ability to check status - generally via the API each sale order takes 5 - 10 seconds to process and become visible to the status endpoint. If you need to query the status immediately use the FLUSH_WAIT parameter instead which causes the API to wait for the orders to complete importing and then returns a response.\n
The Order POST supports XML encoding only at the time of release.
\nSample XML Order Message
\n <NewDataSet>\n <tREMOTETransHeader>\n <Company_ID>DATAPEL</Company_ID>\n <StoreCode>PRESTON</StoreCode>\n <PostingDate>2015-08-31T02:17:08Z</PostingDate>\n <TransID>#2689009</TransID>\n <TransDate/>\n <Salesperson>lyndenmcdonald@yahoo.com.au</Salesperson>\n <CardIdentification>THELNSW</CardIdentification>\n <SaleType>S</SaleType>\n <Special2>ROAD</Special2>\n <ShippingMethod>Star Track</ShippingMethod>\n <ClosedYN>Y</ClosedYN>\n <OriginalSaleType>O</OriginalSaleType>\n </tREMOTETransHeader>\n <tREMOTETransCustomer>\n <ShipToName/>\n <ShipToAddress1>273a Peel Street</ShipToAddress1>\n <ShipToAddress2/>\n <ShipToSuburb>Tamworth</ShipToSuburb>\n <ShipToPostCode>2340</ShipToPostCode>\n <ShipToState>NSW</ShipToState>\n <Address1>273a Peel Street</Address1>\n <Suburb>Tamworth</Suburb>\n <PostCode>2340</PostCode>\n <PhoneNo1>02 6766 9288</PhoneNo1>\n <EmailAddress>shop@lemonhouse.com.au</EmailAddress>\n </tREMOTETransCustomer>\n <tREMOTETransSaleTenders>\n <TenderAmount>0</TenderAmount>\n </tREMOTETransSaleTenders>\n <tREMOTETransSaleLines>\n <SKU>G0751ESS15</SKU>\n <SaleQty>1</SaleQty>\n <SaleUnitAmountIncTax>95.00</SaleUnitAmountIncTax>\n <SaleTaxByHost>Y</SaleTaxByHost>\n <SaleTaxRate>10</SaleTaxRate>\n <SKUDescription>Blue/tan SYKE SMALL BAG (ETA 15-08)</SKUDescription>\n <SalePriceByHost>N</SalePriceByHost>\n </tREMOTETransSaleLines>\n </NewDataSet>\nThe following table describes each property, type and example value.
\n| Property Name | \nExample | \nDescription | \nDetails | \nSize | \nType | \nOption | \n
|---|---|---|---|---|---|---|
| DTD | \nEDIFACTV2 | \nThe document encoding type | \nRequired for Edifact users requiring response codes | \n50 | \nNVARCHAR | \nO | \n
| RevisionNumber | \n1 | \nOrder Revision Num | \nDefault to \"1\" | \n3 | \nINT | \nR | \n
| Company_ID | \nDATAPEL | \nValue must be DATAPEL | \nRequired. Set to “DATAPEL” | \n7 | \nNVARCHAR | \nR | \n
| StoreCode | \nSYD | \nLocation Ship From Code | \nRequired but can be blank will be assigned from default location | \n50 | \nNVARCHAR | \nR | \n
| PostingDate | \n2009-04-29T10:12:20+ | \nDateTime of Transaction | \nOrder Date - format YYYY-MM-DDTHH:MM:SS+ where T and + are separators and terminators | \n\n | INT | \nR | \n
| TransID | \n164101 | \nInvoice Number | \nblank for system allocated ORDER number | \n8 | \nNVARCHAR | \nR | \n
| TransDate | \n2009-04-29T10:12:20+ | \nDateTime of Transaction | \nPromised Date - format YYYY-MM-DDTHH:MM:SS+ where T and + are separators and terminators | \n\n | INT | \nR | \n
| Salesperson | \nLong | \nSalesperson ID | \nLast name of Salesperson. Use “DEFAULT” for system substitute with default salesperson | \n52 | \nNVARCHAR | \nO | \n
| CustomerID | \n2 | \nCustomer ID | \nMYOB CARD RECORD ID | \n\n | INT | \nO | \n
| CardIdentification | \nCUS0000001 | \nMYOB Card Identification or MYOB Tax ID | \nRequired if CustomerID not present. Card Identification of Billing Customer. | \n16 | \nNVARCHAR | \nO | \n
| ShipCustomerID | \n2 | \nCustomer ID | \nOptional MYOB CARD RECORD ID | \n\n | INT | \nO | \n
| ShipCardIdentification | \nCUS0000001 | \nMYOB Card Identification or MYOB Tax ID | \nOptional. Card Identification of Receiving Customer. | \n\n | INT | \nO | \n
| SaleType | \nS | \nType is S - Sale O - Order Q - Quote R- Blind Return X- Exchange | \nS and O for import as order, Q to import as Quote, response file example STDs = R will be a blind return and creates a Goods Inward (as per Sales return workflow), X will create a Sale Order with pick lines - no goods inward and is recommended for workflows where the stock is immediately returned into inventory. | \n1 | \nNVARCHAR | \nR | \n
| Status | \nO | \nNOT RELEVANT IF REMOTE SALE IMPORT AUTO PICK/PACK is SET | \nO - default Order A - Allocate (Sale Type must be Order/Invoice) picks and allocates available inventory | \n1 | \nNVARCHAR | \nO | \n
| Special1 | \n\n | reserved | \ndo not use | \n50 | \nNVARCHAR | \nO | \n
| Special2 | \n2000 | \nPurchase Order | \nCustomers Purchase Order Number | \n50 | \nNVARCHAR | \nO | \n
| Notes | \n\n | \n | “Comment” field in Sale Order | \n255 | \nNVARCHAR | \nO | \n
| SaleNote | \n\n | \n | “Notes” field in Sale Order | \n2500 | \nNVARCHAR | \nO | \n
| ShipNote | \n\n | \n | “Ship Note” field in Sale Order | \n200 | \nNVARCHAR | \nO | \n
| Terms | \n\n | \n | Terms - (attempts Match)if unused/blank then default on card | \n30 | \nNVARCHAR | \nO | \n
| Priority | \n\n | Maps to WMS Order Priority HIGH, HOLD, LOW or as a number (0-3) | \nOptional | \n1 | \nINT | \nO | \n
| ShippingMethod | \nDEFAULT | \n\n | “Name of Method” or “Default” will use customer default shipping method | \n255 | \nNVARCHAR | \nO | \n
| ConNote | \n\n | ConNote - Consignment Number | \n(ASSIGNED IF ALLOCATE SELECTED OR AUTOPICK SET OTHERWISE IGNORED) | \n50 | \nNVARCHAR | \nO | \n
| Sent2HostDateTime | \n2008-04-30T17:02:11 | \nOptional DateTime of XML Emit | \nOptional. Used for logging | \n- | \nINT | \nO | \n
| ReferralSource | \n\n | ReferralSource - mapped to MYOB/WMS referral source descriptions | \nOptional | \n32 | \nNVARCHAR | \nO | \n
| UDF1 | \na1b2text | \nCustom Data Field | \nOptional (maps to Sale Order UDF1) | \n200 | \nNVARCHAR | \nO | \n
| UDF2 | \na1b2text | \nCustom Data Field | \nOptional (maps to Sale Order UDF2) | \n200 | \nNVARCHAR | \nO | \n
| UDF3 | \na1b2text | \nCustom Data Field | \nOptional (maps to Sale Order UDF3) | \n200 | \nNVARCHAR | \nO | \n
| OriginalTransID | \n164101 | \n\n | Internal ref maps to SAL_EDItransid | \n50 | \nNVARCHAR | \nO | \n
| SuppressKits | \nFalse | \nSet to True, Yes, False or No | \nSetting this tag in the XML Sale Header (not done per line) will cause any KIT item to be ignored and imported as a standard item code with the assigned pricing or price by host. (useful when you want to import the kit as a whole not just the kit header) | \n5 | \nNVARCHAR | \nO | \n
| Property Name | \nExample | \nDescription | \nDetails | \nSize | \nType | \nOption | \n
|---|---|---|---|---|---|---|
| ShipToName | \nMary Jones | \nSHIP TO Customer Name | \nCompany or Last Name of Customer | \n\n | \n | O | \n
| ShipToAddress1 | \n174 Hampden Road | \nSHIP TO Address Line 1 | \n\n | \n | \n | O | \n
| ShipToAddress2 | \n\n | SHIP TO Address Line 2 | \n\n | \n | \n | O | \n
| ShipToSuburb | \nNEDLANDS | \nSHIP TO Suburb | \n\n | \n | \n | O | \n
| ShipToPostCode | \n6009 | \nSHIP TO Post Code | \n\n | \n | \n | O | \n
| FaxNo | \n\n | Fax | \n\n | \n | \n | O | \n
| PhoneNo1 | \n1300 856 533 | \nPhone Contact | \nOptional | \n\n | \n | O | \n
| PhoneNo2 | \n\n | Phone Contact | \n\n | \n | \n | O | \n
| EmailAddress | \nbevan.holman@gtp.com.au | \nEmail Address | \nWhen populated and if UDF3 is null or \"\" then data within this field will populate to UDF3 | \n\n | \n | O | \n
| Sent2HostDateTime | \n2009-04-29T10:12:20 | \nOptional DateTime of XML Emit | \nOptional. Used for logging | \n\n | \n | O | \n
| Property Name | \nExample | \nDescription | \nDetails | \nSize | \nType | \nOption | \n
|---|---|---|---|---|---|---|
| TenderType | \nSecurepay | \nPayment Method | \nRequired. Accounting Payment Methods e.g. Credit Card, PayPal. The payment type matching a payment method in the MYOB/WMS database. If no match is found a new comment line will be created within the order to specify the payment type and amount, and users will need to process it in their system manually | \n50 | \nNVARCHAR | \nO | \n
| TenderAmount | \n9.95 | \nPayment Amount | \nRequired. Tax Inclusive Payment Total | \n\n | Float | \nO | \n
| CurrencyCode | \nA | \nSet to A | \nOptional | \n3 | \nNVARCHAR | \nO | \n
| ForeignTenderAmount | \n0.0000 | \nSet to 0.0000 | \nOptional | \n\n | Float | \nO | \n
| TenderLine | \n1 | \nOptional | \n\n | \n | INT | \nO | \n
| Property Name | \nExample | \nDescription | \nDetails | \nSize | \nType | \nOption | \n
|---|---|---|---|---|---|---|
| SKU | \n320 | \nProduct Number / Barcode | \nRequired. Use same item number or Barcode any line with item that cannot be identified cause the entire order to be OnHold and Item number to be entered with “\\c” code | \n50 | \nNVARCHAR | \nR | \n
| HOSKU | \n32102 | \nProduct Number / Barcode | \nIf the is not found it will try for HOSKU if populated | \n50 | \nNVARCHAR | \nO | \n
| SaleQty | \n1 | \nQuantity Sold | \nRequired (unless is populated). as Quantity Sold (eg. Piece) | \n\n | INT | \nR | \n
| SaleUnitQty | \n1 | \nUnit Sold | \nRequired (unless is populated. as Unit Sold (eg. Box) | \n\n | INT | \nR | \n
| SaleUnitAmountIncTax | \n9.95 | \nSale Unit Price | \nRequired if . as per Agreed Unit Sale Price Inc Tax - field takes presidence over if populated | \n\n | Float | \nR | \n
| SaleUnitAmountExcTax | \n9.95 | \nSale Unit Price | \nRequired if is Blank or NULL. as per Agreed Unit Sale Price Excl Tax | \n\n | Float | \nR | \n
| SaleTaxByHost | \nY | \nTax code and amount to be set By the WMS | \nIf Null then next check is | \n3 | \nNVARCHAR | \nO | \n
| SaleTaxCode | \nN-T | \nTax Code | \nif N or NULL then, sets exact Tax Code on sale | \n3 | \nNVARCHAR | \nO | \n
| SaleTaxRate | \n10.00 | \nTax Rate (in Percent value e.g 10.00%) | \nIgnored if match is found. | \n\n | Float | \nO | \n
| SaleTaxUnitAmount | \n0.90 | \nTax Amount | \nIf > 0, automatically changes Tax to GST for line item | \n\n | Float | \nO | \n
| SKUDescription | \nClown Dots | \nProduct Description | \nIf blank allocates default item description (You may also add line Promised Date (not after date) here in the format of #D27/08/2014 it must be at the end of the line description) | \n255 | \nNVARCHAR | \nO | \n
| LineNote | \nMay We have Blue Please | \nAdditional Product Description | \n\n | 200 | \nNVARCHAR | \nO | \n
| JobCode | \nJobCode | \nJob Code (Must already be in the Job Code List to apply/ no new additions) | \n\n | 50 | \nNVARCHAR | \nO | \n
| JobNote | \nJobCodeNote | \nAdditional Text Field | \nDelivery Store ID for Multi Delivery Orders | \n250 | \nNVARCHAR | \nO | \n
| SaleUnitDiscount | \n25.50 | \nDiscount - This is the discount percentage | \n\n | \n | Float | \nO | \n
| SaleRRP | \n9.95 | \nRRP Unit Price | \nOptional. Recommended Unit Retail Sale Price Inc Tax | \n\n | \n | N | \n
| SalePriceByHost | \nY | \nY = Price Set By WMS N = Price Set by Import File | \nOptional - Price set by import file for NULLS | \n3 | \nNVARCHAR | \nO | \n
| CurrencyCode | \nA | \nSet to A | \n\n | \n | \n | N | \n
| SaleLineNo | \n1 | \n\n | \n | \n | INT | \nO | \n
| Cost | \n0.0000 | \nSet to 0.0000 | \n\n | \n | Float | \nO | \n
<tREMOTETransSaleLines>\n.... <repeat node for each order line> ....\n</tREMOTETransSaleLines>
\nMessage Text/String Encoding
\nPreferred string encoding is UTF-8. The fields in the xml file should NOT use cdata and should not contain any of the following characters without encoding ~ < > & TAB CR LF ( ascii 10 / 13).
\nSpecial Character encoding is required as shown below.
\n| Value | \nEncoding | \n
|---|---|
| ~ | \n~tl~ | \n
| < | \n~lt~ | \n
| > | \n~gt~ | \n
| & | \n~am~ | \n
| Chr(9) | \n~09~ | \n
| Chr(10) | \n~10~ | \n
| Chr(13) | \n~13~ | \n
| ' | \nSingle quotes do not require any encoding | \n
For access to the WMS data dictionary please contact Datapel Developer Support
\nFor authorised users please download or review using the following link.
\nRead our Data Dictionary Release 2018
\n(c) Copyright 2018 Datapel Systems Pty Ltd.
\n","event":[{"listen":"prerequest","script":{"id":"9d5c583f-895c-4773-9eb0-0436004ba60b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"62a4a8b3-d156-42f3-a0f8-2a94163f0abc","type":"text/javascript","exec":[""]}}],"_postman_id":"cc4355ce-664e-4f58-aff3-895cb6d5d698"},{"name":"Sample Code","item":[],"id":"82db4c6d-5b4e-4613-9b9f-7c0283694e73","description":"For the latest version of the Datapel Software Developer Kit (SDK) please visit GitHub.
\nhttps://github.com/breezeapi/ccBreezeSDK
\nThis repository provides all the necessary c# libraries to place GET and POST requests to either local or cloud API installations.
\n<?php\n /**\n * Function to fetch access token from DATAPEL\n */\n function get_token($userName, $userPassword) {\n //init the url\n $datapelUrl = \"http://api.datapel.net/json/token\";\n //encapsulate the credentials into a base64 string\n $authString = base64_encode($userName . \":\" . $userPassword);\n\n //init header array\n $header = array();\n $header[] = 'Content-length: 0';\n $header[] = 'Content-type: application/json';\n $header[] = 'Authorization:' . $authString;\n\n //init curl api and send request - returning $data\n $ch = curl_init();\n $timeout = 5;\n curl_setopt($ch, CURLOPT_URL, $datapelUrl);\n curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\n curl_setopt($ch, CURLOPT_HTTPHEADER, $header);\n curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $timeout);\n $data = curl_exec($ch);\n\n //process response - return token or assert error\n if (curl_errno($ch)) {\n echo 'error:' . curl_error($ch) . '<br/>';\n curl_close($ch);\n return '';\n } else {\n //token valid\n $tk = json_decode($data, true);\n curl_close($ch);\n return $tk[0]['token'];\n }\n }\n\n /**\n * Function sample to perform a GET request from endpoint\n */\n function get_data($userName, $userPassword, $token, $filter, $process, $verbetype, $updatetype, $requesttype) {\n //encapsulate the credentials into a base64 string\n $authString = base64_encode($userName . \":\" . $userPassword);\n $ch = curl_init();\n if($requesttype==\"Post\")\n {\n // POST REQUEST\n if($verbetype==\"xml\")\n {\n $filter=str_replace(\"<\",\" <\",$filter);\n $filter=str_replace(\">\",\" >\",$filter);\n $dataToPost=\"<?xml version=\\\"1.0\\\" encoding=\\\"utf-16\\\"?><PostRequest xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\" xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"><updatetype>\".$updatetype.\"</updatetype><filter>\".$filter.\"</filter></PostRequest>\";\n }\n else\n {\n $filter=str_replace('\"','\\\"',$filter);\n $dataToPost=\"{\\\"\".updatetype.\"\\\":\\\"Insert\\\",\\\"filter\\\":\\\"\".$filter.\"\\\"}\";\n }\n curl_setopt($ch, CURLOPT_POST, 1);\n curl_setopt($ch, CURLOPT_POSTFIELDS, $dataToPost);\n $datapelUrl = \"http://api.datapel.net/\".$verbetype.\"/\" . $process . \"?filter~\"; \n }\n else\n {\n // GET REQUEST\n $dataToPost= \"\";\n $datapelUrl = \"http://api.datapel.net/\".$verbetype.\"/\".$process.\"?filter~\".urlencode($filter);\n }\n //init header array\n $header = array();\n //$header[] = 'Content-length:'.strlen($dataToPost);\n $header[] = 'Content-type: application/json';\n $header[] = 'Authorization: '.$authString;\n $header[] = 'Auth_Token: '.$token;\n\n echo $datapelUrl;\n echo nl2br(\"\\n\");\n echo nl2br(\"\\n\"); \n //init curl api and send request - return data\n\n $timeout = 5;\n\n curl_setopt($ch, CURLOPT_URL, $datapelUrl);\n curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\n curl_setopt($ch, CURLOPT_HTTPHEADER, $header);\n curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $timeout);\n $data = curl_exec($ch);\n curl_close($ch);\n return $data;\n }\n\n // get token\n $session_token = get_token(\"superuser\",\"password\");\n // request server timestamp\n echo get_data(\"superuser\", \"password\", $session_token, \"\", \"timestamp\", \"json\", \"Query\", \"GET\");\n echo nl2br(\"\\n\");\n\n // request itemlist element by itemnumber match\n echo get_data(\"superuser\", \"password\", $session_token, \"itemnumber='\\c'\", \"items\", \"json\", \"Query\", \"GET\");\n echo nl2br(\"\\n\");\n\n?>\nThe following code snippet demonstrates how to authenticate with the Breeze DataServer and obtain an authorisation token. Using the token a GET Query is made to inquire on the server timestamp and item code.
\n/*!\n * Datapel apiConnect Library v1.2.0 (http://api.datapel.net)\n * Copyright 2011-2016 Datapel Systems Pty Ltd.\n * Licensed under MIT\n */\n\nif (typeof jQuery === 'undefined') { throw new Error('Datapel API Connection JavaScript requires jQuery') }\n\n/* ========================================================================\n * apiConnect: apiConnect.js v1.2.0\n * http://api.datapel.net/samplecode\n * ========================================================================\n * Copyright 2011-2016 Datapel Systems Pty Ltd.\n *\n * Example Usage:\n * ========================================================================\n * apiConnect.username = \"username\";\n * apiConnect.password = \"password\";\n * apiConnect.url = \"http://url:port\";\n * \n * ======================================================================== */\n\nvar apiConnect = new function () {\n // Define Connection Properties\n this.masterKey = \"\";\n this.username = \"\";\n this.password = \"\";\n this.url = \"\";\n this.token = \"\";\n this.recordCount = 0;\n this.pageCount = 0;\n this.pageNumber = 0;\n this.pageSize = 0;\n this.pageStartTime = 0;\n this.pageEndTime = 0;\n this.pagePrimaryKeyName = \"\";\n this.pageTableName = \"\";\n this.pageQueryFilter = \"\";\n this.pageColumns = \"\";\n this.pageTag = \"\";\n this.pageElapseTime = 0;\n this.pageResultSet = [];\n this.requestResultSet = [];\n this.requestEstimatedTime = 0;\n this.onPageComplete = function(){};\n this.onPageException = function(){};\n this.onRequestReady = function(){};\n this.onRequestComplete = function(){}; \n this.localscope = {};\n\n // ========================================================================\n // openService()\n //\n this.openService = function (callBack) {\n // allow cross domain access\n $.support.cors = true;\n // Initialise the token\n this.token = \"\";\n // Encode authorisation credentials\n this.masterKey = this.encode64(this.username + ':' + this.password);\n // Request API session token\n var urlGet = this.url + \"/json/token?authorization~\" + this.masterKey;\n // Make request\n $.ajax({\n url: urlGet,\n type: 'GET',\n crossDomain: true,\n async: true,\n success: function(result) {\n // check response is valid\n if(result!=null && result !=undefined) {\n this.token = result[0].token;\n //successful result\n console.log(\"Got Valid Token :\" + this.token); \n // trigger the caller\n callBack(this.token); \n } else {\n //invalid result\n callBack(false); \n } \n },\n error: function() {\n //failed result \n callBack(false); \n }\n });\n };\n // ========================================================================\n // getRequest()\n // \n this.getRequest = function (apiResource, apiFilter, callBack) {\n var urlResponse;\n // form the request based on the resource\n var urlRequest = this.url + \"/json/\" + apiResource + \"?filter~\" + encodeURI(apiFilter);\n // append security credentials\n urlRequest = urlRequest + '&authorization=' + this.masterKey + '&auth_token=' + this.token;\n // pass request to server\n console.log(\"requesting: \" + urlRequest);\n // allow cross domain by default\n $.support.cors = true;\n // Make request\n $.ajax({\n // pass the resource request\n url: urlRequest,\n type: 'GET',\n crossDomain: true,\n async: true,\n success: function(result) {\n // completed request\n callBack(result);\n },\n error: function() {\n //failed result \n callBack(false);\n }\n });\n }; \n // ========================================================================\n // getTimeStamp()\n // \n this.getTimeStamp = function (callBack) {\n var urlResponse;\n // form the request based on the resource\n var urlRequest = this.url + \"/json/timestamp?filter~\";\n // append security credentials\n urlRequest = urlRequest + '&authorization=' + this.masterKey + '&auth_token=' + this.token;\n // pass request to server\n console.log(\"requesting: \" + urlRequest); \n // allow cross domain by default\n $.support.cors = true;\n // Make request\n $.ajax({\n // pass the resource request\n url: urlRequest,\n type: 'GET',\n crossDomain: true,\n async: true,\n success: function(result) {\n // check response is valid\n if(result!=null && result !=undefined) {\n //successful result\n callBack(result.ServerTimeStamp); \n } else {\n //invalid result\n callBack(false); \n } \n },\n error: function() {\n //failed result \n callBack(false); \n }\n });\n };\n // ========================================================================\n // getDataSetPage()\n // \n this.getDataSetPage = function (tableName, tableColumns, tableFilter, tablePkey, pageSize, pageNumber) {\n var queryString = \"\";\n try {\n // All Rows or filtered dataSet\n if (!tableFilter.trim()) {\n // is empty or whitespace\n tableFilter = \"1=1\";\n }\n // All Columns or subSet\n if (!tableColumns.trim()) {\n // is empty or whitespace\n tableColumns = \"*\";\n }\n // create the page query with filter\n queryString = \"SELECT \" + tableColumns + \" FROM \" + tableName + \" WHERE \" + tableFilter + \" AND \" + tablePkey + \" IN \";\n queryString = queryString + \"(SELECT TOP \" + pageSize + \" \" + tablePkey + \" FROM \" + tableName + \" WHERE \" + tableFilter + \" AND \" + tablePkey + \" NOT IN \";\n queryString = queryString + \"(SELECT TOP \" + pageSize*(pageNumber-1) + \" \" + tablePkey + \" FROM \" + tableName + \" WHERE \" + tableFilter + \" ORDER BY \" + tablePkey + \")\";\n queryString = queryString + \" ORDER BY \" + tablePkey + \")\" + \" ORDER BY \" + tablePkey;\n // echo the query for debug\n console.log(\"Page Query:\" + queryString);\n //debugger; \n\n } catch (ex) {\n alert(\"getDataset: Failed!\");\n console.log(\"Error:\" + ex.message);\n queryString = \"\"; \n }\n // Return the page query\n return(queryString);\n };\n\n // ========================================================================\n // getPagedRequest()\n // \n this.getPagedRequest = function (tableFilter, onPageComplete, onPageException, onRequestReady, onRequestComplete) {\n // New QueryString\n var queryRequest = \"\";\n var self = this; \n // Initialise context\n self.pageQueryFilter = tableFilter;\n // Initialise Event CallBacks\n self.onPageComplete = onPageComplete;\n self.onPageException = onPageException;\n self.onRequestReady = onRequestReady;\n self.onRequestComplete = onRequestComplete;\n self.pageResultSet = [];\n self.requestResultSet = [];\n // Determine the number of records in the dataSet\n setTimeout(function() {\n // From Table get RecordCount\n queryRequest = \"SELECT COUNT(*) AS recordCount FROM \" + self.pageTableName + \" WHERE \" + self.pageQueryFilter;\n apiConnect.getRequest(\"sql\", queryRequest, apiConnect.pagedRequestBegin); \n }, 3000); \n }; \n // ========================================================================\n // pagedRequestBegin()\n // \n this.pagedRequestBegin = function (resultSet) {\n var queryRequest = \"\";\n var recordCount = 0;\n var pagesCount = 1;\n var self = apiConnect; \n // Echo resultSet to console\n if (resultSet) {\n console.log(\"Items Loaded :\" + JSON.stringify(resultSet));\n } else {\n console.log(\"No results.\");\n }\n // Validate the previous resultSet \n if (resultSet) {\n console.log(\"Records Loaded :\" + JSON.stringify(resultSet));\n recordCount = parseInt(resultSet[0].recordCount);\n if (recordCount > 0) {\n pagesCount = Math.ceil(recordCount / self.pageSize);\n }\n } else {\n console.log(\"No results.\");\n }\n // Initialise the apiConnect with pageCount \n self.pageCount = pagesCount;\n // initiate the event callback\n self.onRequestReady('onRequestReady');\n // fire Request(\"sql-request\", filter-select query, callBack)\n setTimeout(function() {\n // Complete Request\n self.pageNumber = 1;\n queryRequest = self.getDataSetPage(self.pageTableName, self.pageColumns, self.pageQueryFilter, self.pagePrimaryKeyName, self.pageSize, self.pageNumber);\n if (queryRequest.trim()) {\n self.pageStartTime = performance.now();\n self.getRequest(\"sql\", queryRequest, self.pagedRequestNext);\n } else {\n console.log(\"Server Connection Failed: (Invalid DataSet)\"); \n } \n }, 3000); \n };\n // ========================================================================\n // pagedRequestNext()\n // \n this.pagedRequestNext = function (resultSet) {\n // New QueryString\n var queryRequest = \"\";\n var self = apiConnect;\n // Mark Page Loaded\n self.pageEndTime = performance.now();\n self.pageElapseTime = self.pageEndTime - self.pageStartTime;\n self.requestEstimatedTime = self.pageElapseTime * self.pageCount;\n // Echo resultSet to console\n if (resultSet) {\n self.pageResultSet = resultSet;\n self.requestResultSet = self.requestResultSet.concat(resultSet);\n console.log(\"pageResultSet :\" + JSON.stringify(resultSet)); \n } else {\n console.log(\"No results.\");\n }\n // initiate the event callback\n self.onPageComplete('onPageComplete'); \n // Page Download Complete - step to next page\n self.pageNumber = self.pageNumber + 1; \n // fire page Request with filter-select query, then callBack\n setTimeout(function() {\n // Complete Request\n self.pageStartTime = performance.now();\n queryRequest = self.getDataSetPage(self.pageTableName, self.pageColumns, self.pageQueryFilter, self.pagePrimaryKeyName, self.pageSize, self.pageNumber);\n if (queryRequest.trim()) {\n if (self.pageNumber != self.pageCount) {\n // Download next page in Request Set\n self.getRequest(\"sql\", queryRequest, self.pagedRequestNext);\n } else {\n // Final page download in Request Set\n self.getRequest(\"sql\", queryRequest, self.pagedRequestComplete); \n }\n } else {\n console.log(\"Server Connection Failed: (Invalid DataSet)\");\n } \n }, 3000); \n };\n // ========================================================================\n // pagedRequestComplete()\n // \n this.pagedRequestComplete = function (resultSet) {\n try {\n var self = apiConnect;\n if (resultSet) {\n self.pageResultSet = resultSet;\n self.requestResultSet = self.requestResultSet.concat(resultSet);\n console.log(\"requestResultSet :\" + JSON.stringify(self.requestResultSet));\n } else {\n console.log(\"No results.\");\n }\n // initiate the event callback\n self.onRequestComplete('onRequestComplete'); \n console.log(\"Request COMPLETE!\");\n } catch (ex) {\n alert(\"Failed!\");\n console.log(\"Error:\" + ex.message); \n } \n }; \n // Use this function to encode64 ONLY FOR APIKEY\n this.encode64 = function (input) {\n\n var keyStr = \"ABCDEFGHIJKLMNOP\" +\n \"QRSTUVWXYZabcdef\" +\n \"ghijklmnopqrstuv\" +\n \"wxyz0123456789+/\" +\n \"=\";\n\n var output = \"\";\n var chr1, chr2, chr3 = \"\";\n var enc1, enc2, enc3, enc4 = \"\";\n var i = 0; \n do {\n chr1 = input.charCodeAt(i++);\n chr2 = input.charCodeAt(i++);\n chr3 = input.charCodeAt(i++);\n enc1 = chr1 >> 2;\n enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);\n enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);\n enc4 = chr3 & 63;\n if (isNaN(chr2)) {\n enc3 = enc4 = 64;\n } else if (isNaN(chr3)) {\n enc4 = 64;\n }\n output = output +\n keyStr.charAt(enc1) +\n keyStr.charAt(enc2) +\n keyStr.charAt(enc3) +\n keyStr.charAt(enc4);\n chr1 = chr2 = chr3 = \"\";\n enc1 = enc2 = enc3 = enc4 = \"\";\n } while (i < input.length);\n return output;\n };\n};\nThe following code snippet demonstrates the use of the apiConnect class to connect and make requests using callback functions.
\n <index.html>\n .....\n <script src=\"assets/js/apiConnect.js\"></script>\n\n <script>\n $(document).ready(function() {\n Main.init();\n\n });\n\n function connectInit() {\n try {\n // Open Connection to API Server\n apiConnect.username = \"superuser\";\n apiConnect.password = \"password\";\n apiConnect.url = \"http://api.datapel.net\";\n // initialise Page Helper defaults\n apiConnect.pageNumber = 1;\n apiConnect.pageSize = 20;\n apiConnect.recordCount = 0; \n\n setTimeout(function() {apiConnect.openService(connectComplete); }, 1000); \n\n } catch(ex) {\n console.log(\"Error:\" + ex.message); \n }\n };\n\n function connectComplete(token) {\n if (token) {\n apiConnect.token = token;\n console.log(\"Authenticated...\" + token);\n // Trigger Connection Verification\n setModalMessage('Verifying Connection...');\n setTimeout(function() {apiConnect.getTimeStamp(connectReady); }, 1000); \n\n } else {\n console.log(\"Server Connection Failed.\");\n // Unable to connect - Check username / password or connection\n setModalMessage('Server Connection Failed: (No resource available)'); \n }\n };\n\n function connectReady(timeStamp) {\n if (timeStamp) {\n console.log(\"Connected @ \" + timeStamp);\n //Connection Successful\n setModalMessage('Connected @ ' + timeStamp); \n // Display Connected Status\n // Continue to access Api\n } else {\n console.log(\"Connection Not Ready.\");\n }\n };\nTo view our API glossary please click here.
\n","event":[{"listen":"prerequest","script":{"id":"d87e653d-f909-437c-8fc4-9cc29d032929","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"37a2e9f9-53cb-4464-8c09-e7ce7fa23e37","type":"text/javascript","exec":[""]}}],"_postman_id":"9102c31c-a518-4079-bfe8-4f97bc522996"},{"name":"Endpoints","item":[{"name":"Sales Queue","id":"98e19c76-cfb8-40df-a69b-986cec4676d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"NewDataSet\": {\n \"tREMOTETransHeader\": {\n \"Company_ID\": \"Posts sale data to the queue.
\n","urlObject":{"path":["salesqueue"],"host":["http://api.datapel.net/JSON"],"query":[],"variable":[]}},"response":[{"id":"fb8e1576-a53b-4949-a428-75ccb48ca11e","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"NewDataSet\": {\n \"tREMOTETransHeader\": {\n \"Company_ID\": \"Retrieve sale data from the sales queue.
\n","urlObject":{"path":["salesqueue"],"host":["http://api.datapel.net/JSON"],"query":[{"description":{"content":"Delete the containing JSON queue files.
\n","type":"text/plain"},"key":"DELETE","value":"Remove the lock.
\n","type":"text/plain"},"key":"FLUSH","value":"Wait.
\n","type":"text/plain"},"key":"FLUSH_WAIT","value":"Unlock the folder
\n","type":"text/plain"},"key":"UNLOCK","value":"Lock the folder.
\n","type":"text/plain"},"key":"WITHLOCK","value":"