This Postman collection showcases the various OODAPI endpoints, and example usages of them.
\nAny updates or actions performed by these requests do impact the server on which they run. If you update, add, or delete information -- it will be updated, added, or deleted on the targeted server on a successful request.
\nPlease make sure your CompanyID is set to a test company for testing, otherwise some actions on REST endpoints will default an empty CompanyID to the one you have current access to, and may alter live production data!
Variables
\nYou will see variables set with placeholder text within double curly braces, in both the URL and the body section of GET and POST requests respectively. This is the formatting for string interpolation, which will replace the double curly braces as well as the placeholder text for the variable with the current value established in the Variables tab of the OODAPI Examples collection.
This Postman collection makes use of two variables -- APIKey and ServerPath. You only need to update these two variables in order to change all requests in this collection. This makes it much easier to modify the APIKey and server you're testing on.
Recommended Setup
\nThe OODAPI generally requires the API Key to be provided in the form of an HTTP Header with X-API-Key or in the body of the HTTP Request, typically in JSON format. (XML is also supported, though discouraged.)
You must have the following:
\nA valid API Key. You can get this from the Users master screen within the Odyssey Web Interface.
Update the APIKey variable in this Postman collection with the API Key you get from Odyssey.
Update the ServerPath variable in this Postman collection with the location of your OODAPI.
For B&L Cloud customers, your OODAPI URL exists at https://api.blinfo.com/
For On Premise customers, your OODAPI URL exists at the location of your Odyssey install, with OODAPI appended. For example, if you go to https://mydomain.com/odyssey/odyssey.aspx to get to the Web UI, your OODAPI would exist at https://mydomain.com/odyssey/OODAPI
Please contact B&L Information Systems for additional support.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Important Notice","slug":"important-notice"}],"owner":"3905539","collectionId":"93ac07ba-4c94-4214-b5ea-5f2b477b1468","publishedId":"SzKTwKCU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-02-20T18:58:55.000Z"},"item":[{"name":"/AP","item":[{"name":"APInvoiceTransaction","id":"a10032a6-af51-426b-abb0-9ae3e7449af9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This allows you to send and receive data as JSON.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Account\": \"\",\r\n \"APInvChgAcct\": \"\",\r\n \"AutoCreate\": \"\",\r\n \"AutoPost\": \"\",\r\n \"Batch\": \"\",\r\n \"ChargeCode\": \"\",\r\n \"Comments\": \"\",\r\n \"CostType\": \"\",\r\n \"CurrCode\": \"\",\r\n \"Description\": \"\",\r\n \"DiscountDate\": \"\",\r\n \"DiscountDollarsDtl\": \"\",\r\n \"DiscountPercentDtl\": \"\",\r\n \"DueDate\": \"\",\r\n \"Equipment\": \"\",\r\n \"ExchgRate\": \"\",\r\n \"GLDate\": \"\",\r\n \"GrossDollarsDtl\": \"\",\r\n \"Hold\": \"\",\r\n \"ICBeenScanned\": \"\",\r\n \"InternalInterfaceID\": \"\",\r\n \"InvEntryDate\": \"\",\r\n \"InvoiceDate\": \"\",\r\n \"Item\": \"\",\r\n \"JobNumber\": \"\",\r\n \"ManualBankCode\": \"\",\r\n \"ManualCheck\": \"\",\r\n \"ManualCheckAmount\": \"\",\r\n \"ManualCheckDate\": \"\",\r\n \"ManualCheckNumber\": \"\",\r\n \"MaterialID\": \"\",\r\n \"OrderItem\": \"\",\r\n \"OrderNumber\": \"\",\r\n \"OrderType\": \"\",\r\n \"PaymentGroup\": \"\",\r\n \"POItem\": \"\",\r\n \"PONumber\": \"\",\r\n \"PayMethod\": \"\",\r\n \"Qty\": \"\",\r\n \"Receiver\": \"\",\r\n \"RefDesc\": \"\",\r\n \"SepCheck\": \"\",\r\n \"StopCode\": \"\",\r\n \"SupplierID\": \"\",\r\n \"SupplierInvNum\": \"\",\r\n \"TermCode\": \"\",\r\n \"Tool\": \"\",\r\n \"ToolCostType\": \"\",\r\n \"CompanyID\": \"ODSY\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blinfo.com/company/AP/APInvoiceTransaction","description":"Allows for importing into the A/P Transactions (APTransactions) table to easily create invoices from a source outside of Odyssey
\nAccount - Type String:
\nAccount Number to be charged for this item.
\nAPInvChgAcct - Type Boolean:
\nThis flag indicates that this is the inventory/expense account
\nAutoCreate - Type Boolean:
\nThis flag determines whether the invoice is auto created or not
\nAutoPost - Type Boolean:
\nAutomatically post transaction when imported.
\nBatch - Type Integer:
\nThe number associated with this batch of A/P invoices.
\nChargeCode - Type String:
\nThe miscellaneouse charge code associated with this charge.
\nComments - Type String:
\nComments entered here will become a comment on the invoice item once it is created.
\nCostType - Type String:
\nUser defined cost type for accumulating equipment costs.
\nCurrCode - Type String:
\nUnique identifier for the currency.
\nDescription - Type String:
\nBrief description of this invoice item.
\nDiscountDate - Type String:
\nThe date payment is due if the discount is to be taken.
\nDiscountDollarsDtl - Type Decimal:
\nDiscount dollars for this invoice item.
\nDiscountPercentDtl - Type Decimal:
\nDiscount percent associated with this invoice item.
\nDueDate - Type String:
\nThe date payment is desired for this invoice.
\nEquipment - Type String:
\nEquipment associated with this invoice.
\nExchgRate - Type Decimal:
\nCurrent exchange rate from this currency to native currency.
\nGLDate - Type String:
\nThe date the invoice will be posted to the General Ledger.
\nGrossDollarsDtl - Type Decimal:
\nGross dollars for this invoice item.
\nHold - Type Boolean:
\nDefines whether the invoice is on hold and cannot be posted to open payables.
\nICBeenScanned - Type Boolean:
\nIndicates whether or not the invoice has been scanned into IntelliChief.
\nInternalInterfaceID - Type String:
\nThis field is used internally with intellichief as a unique identifier.
\nInvEntryDate - Type String:
\nThe date the invoice was entered.
\nInvoiceDate - Type String:
\nThe date on the invoice.
\nItem - Type Integer:
\nThe Invoice item.
\nJobNumber - Type String:
\nJob cost number this item is being charged against.
\nManualBankCode - Type String:
\nBank code associated with this manual payment.
\nManualCheck - Type Boolean:
\nDefines if the invoice was paid with a manual payment.
\nManualCheckAmount - Type Decimal:
\nManual payment amount for this invoice.
\nManualCheckDate - Type String:
\nThe date of the manual payment for this invoice.
\nManualCheckNumber - Type Int64:
\nManual check/reference number paying this invoice.
\nMaterialID - Type String:
\nMaterial number associated with this invoice item.
\nOrderItem - Type Integer:
\nOrder item number this invoice is being invoiced against.
\nOrderNumber - Type Integer:
\nOrder number this invoice is being invoiced against.
\nOrderType - Type String:
\nIdentifies the type of order (customer order(C), shop order(S), work order(W), tool order(T) etc.).
\nPaymentGroup - Type String:
\nUser defined grouping for payment of invoices.
\nPOItem - Type Integer:
\nPurchase order item associated with this item.
\nPONumber - Type Integer:
\nPurchase order associated with this item.
\nPayMethod - Type String:
\nDesignates the manual payment method (M=Manual Check, E=Electronic Payment, C=Credit Card)
\nQty - Type Integer:
\nQuantity being invoiced with this item.
\nReceiver - Type Integer:
\nReceiver number for this material.
\nRefDesc - Type String:
\nReference or description for the manual payment.
\nSepCheck - Type Boolean:
\nRevision level for this item.
\nStopCode - Type String:
\nStop payment on this invoice.
\nSupplierID - Type String:
\nSupplier associated with this invoice.
\nSupplierInvNum - Type String:
\nSupplier's invoice number associated with this invoice.
\nTermCode - Type String:
\nPayment terms for this invoice.
\nTool - Type String:
\nTool number this item is being invoiced against.
\nToolCostType - Type String:
\nUser defined cost type for accumulating tooling costs.
\n","urlObject":{"path":["AP","APInvoiceTransaction"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"a10032a6-af51-426b-abb0-9ae3e7449af9"}],"id":"3ac7af81-aebc-40d4-a511-51ef5887941b","_postman_id":"3ac7af81-aebc-40d4-a511-51ef5887941b","description":""},{"name":"/Clocking","item":[{"name":"/In","id":"e4ed5fef-b78b-47b4-8efd-17430ef5a4fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Badge\": \"1234\",\r\n \"Date\": \"\",\r\n \"Time\": \"\",\r\n \"CompanyID\": \"ODSY\"\r\n}"},"url":"https://api.blinfo.com/company/Clocking/In","description":"Clock an employee in. If the employee is already clocked in, the system will generate an error.
\nBadge - Type String :\nRequired badge number of the employee that is clocking in.
\nDate - Type String :\nOptional date that the employee is clocking in. This must be in MMDDYYYY format. If not specified, the current system date will be used.
\nTime - Type String :\nOptional time that the employee is clocking in. This must be in military time with a HHMMSS format. If not specified, the current system time will be used.
\n","urlObject":{"path":["Clocking","In"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4ed5fef-b78b-47b4-8efd-17430ef5a4fc"},{"name":"/Info","id":"78458703-2171-4540-a936-b93f284fbd79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/Clocking/Info","description":"Returns configuration information for the quick clock screen
\nThis endpoint has no required parameters.
\n","urlObject":{"path":["Clocking","Info"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"78458703-2171-4540-a936-b93f284fbd79"},{"name":"/Out","id":"8a03cc55-c220-470f-b0b6-3ed3c73e175a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Badge\": \"1234\",\r\n \"Date\": \"\",\r\n \"Time\": \"\",\r\n \"CompanyID\": \"ODSY\"\r\n}"},"url":"https://api.blinfo.com/company/Clocking/Out","description":"Clock an employee out. If the employee is already clocked out, the system will generate an error.
\nBadge - Type String :\nRequired badge number of the employee that is clocking out.
\nDate - Type String :\nOptional date that the employee is clocking out. This must be in MMDDYYYY format. If not specified, the current system date will be used.
\nTime - Type String :\nOptional time that the employee is clocking out. This must be in military time with a HHMMSS format. If not specified, the current system time will be used.
\n","urlObject":{"path":["Clocking","Out"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a03cc55-c220-470f-b0b6-3ed3c73e175a"},{"name":"/QuickClock","id":"c290ac63-b233-4e10-99ed-0e497cd59a89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Badge\": \"1234\",\r\n \"Date\": \"\",\r\n \"Time\": \"\",\r\n \"CompanyID\": \"ODSY\"\r\n}"},"url":"https://api.blinfo.com/company/Clocking/QuickClock","description":"Perform a quick clock punch. If the employee is not clocked in, they will be clocked in. If the employee is already clocked in, they will be clocked out.
\nBadge - Type string :\nRequired badge number of the employee that is clocking.
\nDate - Type String :\nOptional date that the employee is clocking. This must be in MMDDYYYY format. If not specified, the current system date will be used.
\nTime - Type String :\nOptional time that the employee is clocking. This must be in military time with a HHMMSS format. If not specified, the current system time will be used.
\n","urlObject":{"path":["Clocking","QuickClock"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"c290ac63-b233-4e10-99ed-0e497cd59a89"}],"id":"78dc581f-103b-4264-a7bb-c212b5c72e7b","_postman_id":"78dc581f-103b-4264-a7bb-c212b5c72e7b","description":""},{"name":"/Customer","item":[{"name":"{GET}","id":"97bf08c7-19c9-48bf-939e-b929d8b1d4ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","value":"Returns up to 1,000 matching, Active Customers from the MainDB.Customer table.
\nIf a search text value is provided, records will be returned where the ID, or COName match the given value (using a wild-card matches search).
\nSearchText - Type string :
This value, if supplied, will be used to filter your results. This value will be searched using a MATCHES operator on the ID OR COName fields in the Customer table.
CompanyID - Type string :
The optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Fetch a specific customer from the Odyssey database from the MainDB.Customer table.
\nThese parameters are automatically passed to the API call because they're included as part of the URL to access the API endpoint
\nUniqueID - Type integer :\nThe UniqueID of the customer you are searching for. This customer can exist in any company you have access to.
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\n","urlObject":{"path":["Customer","47319"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"0eda24fb-6ad1-47bf-8cb9-1b02d70c95cd"},{"name":"/{UniqueID}/PlantFields","id":"0eb6d3a7-525f-4ee7-b496-df8cdec44fcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Returns a list of plant-level fields that a controlling company can change for a specific Customer and their current values.
\nThese parameters are automatically passed to the API call because they're included as part of the URL to access the API endpoint
\nUniqueID - Type integer :\nThe UniqueID of the customer you are fetching fields for. This customer should exist within the HQ company.
\nCompanyID - Type string :\nThe optional CompanyID. If you're using a company-specific APIKey, this value is not required. The CompanyID associated with your APIKey will be used to fetch the plant-level fields. If you're using a non-company-specific APIKey, then this value is required.
\n","urlObject":{"path":["Customer","47319","PlantFields"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"0eb6d3a7-525f-4ee7-b496-df8cdec44fcd"},{"name":"/{UniqueID}/PlantFields","id":"d5c8c5f4-c274-450f-8780-f6917ba1d38b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Allows for updating plant-level fields from a Headquaters company for a selected Customer.
\nThese parameters are automatically passed to the API call because they're included as part of the URL to access the API endpoint
\nUniqueID - Type integer :\nThe UniqueID of the customer you are fetching fields for. This customer should exist within the HQ company.
\nCompanyID - Type string :\nThe optional CompanyID. If you're using a company-specific APIKey, this value is not required. The CompanyID associated with your APIKey will be used to fetch the plant-level fields. If you're using a non-company-specific APIKey, then this value is required.
\nPlantList - Type string array :\nThis is a list of the CompanyID's of the plants to be updated.
\nFields - Type *PlantFieldUpdateModel array :\nThis is an array of all the fields that are being returned containing information the front-end will use to build the screen
\nFieldValue - Type string :\nThe new value of the field you wish to apply to all the plants in the PlantList
\nField - Type PlantFieldModel :\nThe entire field object that you are updating.
\nFieldName - Type string :\nThe name of the field
\nFieldLabel - Type string :\nThe label of the field
\nDataType - Type string :\nThe data type of the field. Integer, String, Boolean, etc
\nFormat - Type string :\nThe display format of the field. The possible values are: - Boolean Values - yes/no - This format represents a value that is either true or false. These values are typically represented as checkboxes. - Character Values - X(number) - This format means that you can input a character string of \"number\" length. For example, X(10) means that you can enter a string of up to 10 characters, and only the first 10 characters of the value will be displayed. - Integer Or Decimal Values - >>>,>>>, -99,999, >>>>, etc - This format represents how long the field is and where any commas may be present. It also indicates if if the field supports negative (-) numbers or not. - Date Values - MM/DD/YY, DD/MM/YYYY, MM/DD/YYYY HH:MM:SS, etc - This format indicates how the date and associated time, if any, will be displayed.
\nFieldValue - Type string :\nThe current value of this field
\nOptions - Type string :\nThe list of possible options for this field, if this field's DataType is 'List'.
\nPlantValues - Type Dictionary<string, string> :\nA list of all plants in this organization, and the value for this field in that plant, if it exists.
\n","urlObject":{"path":["Customer","47319","PlantFields"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"d5c8c5f4-c274-450f-8780-f6917ba1d38b"}],"id":"31f5044d-eaeb-4613-987d-6e554ddd0c37","_postman_id":"31f5044d-eaeb-4613-987d-6e554ddd0c37","description":""},{"name":"/CRM","item":[{"name":"/Customer","item":[{"name":"{GET}","id":"bfbeef76-9df8-4e0f-9cd4-1a4cf5044349","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Returns up to 1,000 matching, Active Customers from the MainDB.CustProspect table. If a search text value is provided, records will be returned where the COName, ID, or SearchWords match the given value (using a wild-card matches search).
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nSearchText - Type string :\nThis optional text will be searched for in the \"COName\", \"ID\", and \"SearchWords\" fields
\n","urlObject":{"path":["CRM","Customer"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"SearchText","value":""}],"variable":[]}},"response":[],"_postman_id":"bfbeef76-9df8-4e0f-9cd4-1a4cf5044349"}],"id":"ec11358f-7f81-4832-ae82-5bb85bf7445d","_postman_id":"ec11358f-7f81-4832-ae82-5bb85bf7445d","description":""},{"name":"/Prospect","item":[{"name":"{GET}","id":"1a84b79c-906c-4949-9815-07c76ae8aa0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Returns up to 1,000 matching, Active Prospects from the MainDB.CustProspect table. If a search text value is provided, records will be returned where the COName, ID, or SearchWords match the given value (using a wild-card matches search).
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nSearchText - Type string :\nThis optional text will be searched for in the \"COName\", \"ID\", and \"SearchWords\" fields
\n","urlObject":{"path":["CRM","Prospect"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"SearchText","value":""}],"variable":[]}},"response":[],"_postman_id":"1a84b79c-906c-4949-9815-07c76ae8aa0c"}],"id":"917a5468-228f-44b5-b473-4b7df384aaef","_postman_id":"917a5468-228f-44b5-b473-4b7df384aaef","description":""},{"name":"/Info","item":[{"name":"{GET}","id":"58a5b671-5e27-46f9-9cd5-2edd7ee14ae3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Gets information that can be used to control note creation with the CRM. It can return information about a customer or prospect by email address, but will always return the types of files that are allowed to be uploaded, and whether files are allowed to be uploaded at all
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nEmail - Type string :\nThis optional email address of a customer or prospect that will be looked for in the MainDB.CustProspect table
\n","urlObject":{"path":["CRM","Info"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"Email","value":""}],"variable":[]}},"response":[],"_postman_id":"58a5b671-5e27-46f9-9cd5-2edd7ee14ae3"}],"id":"d5e330fe-7e97-4a34-8a3e-c51b4610d150","_postman_id":"d5e330fe-7e97-4a34-8a3e-c51b4610d150","description":""},{"name":"/Note","item":[{"name":"{POST} (with files)","id":"2d5feee9-3ee7-4c89-939e-e14483419c5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"This endpoint allows you to create a CRM note for a Customer or Prospect. If you wish to add files to your note, you must add these files and the required parameters in the content of a multipart/form-data request. This example shows how to do that in Postman. If you wish to see an example not uploading files, please see the other example (without files).
\nThis request must be sent with \"multipart/form-data\" encoding to allow files to be attached to your note. If not uploading files, then you can send a normal JSON request to the API to create your note. If you are uploading files, then add them as files to your request, and the API will automatically collect all files sent and attach them as a Link to the new note. In either case, the following properties can or must be used when sending emails.
UniqueID - Type integer :\nThe UniqueID of the MainDB.CustProspect record you're attaching a note to
Description - Type string :\nThe Description (title) of the note you're creating
\nNote - Type string :\nThe content of the note you're creating
\nDate - Type string :\nThe date that this note should be created for. This must be in the ISO date format of YYYY-MM-DD
\nTime - Type string :\nThe time that this note should be created for. This must be in 24H format of HH:MM:SS
Example: for 11:50PM and 12 seconds - you'd send '23:50:12'
For 11:50AM and 30 seoncds - you'd send '11:50:30'
CompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nAPIKey - Type string :\nThe optional APIKey used to authenticate this request. If not specified here, it must be specified in the X-API-Key HTTP header
\n","urlObject":{"path":["CRM","Note"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d5feee9-3ee7-4c89-939e-e14483419c5f"},{"name":"{POST} (without files)","id":"18eb3c00-fc58-41a9-919f-b637c0ee0654","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"This endpoint allows you to create a CRM note for a Customer or Prospect. If you wish to add files to your note, you must add these files and the required parameters in the content of a multipart/form-data request. Please see the other example (with files) for an example in Postman of how this can be done.
\nUniqueID - Type integer :\nThe UniqueID of the MainDB.CustProspect record you're attaching a note to
\nDescription - Type string :\nThe Description (title) of the note you're creating
\nNote - Type string :\nThe content of the note you're creating
\nDate - Type string :\nThe date that this note should be created for. This must be in the ISO date format of YYYY-MM-DD
\nTime - Type string :\nThe time that this note should be created for. This must be in 24H format of HH:MM:SS
Example: for 11:50PM and 12 seconds - you'd send '23:50:12'
For 11:50AM and 30 seoncds - you'd send '11:50:30'
CompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nAPIKey - Type string :\nThe optional APIKey used to authenticate this request. If not specified here, it must be specified in the X-API-Key HTTP header
\n","urlObject":{"path":["CRM","Note"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"18eb3c00-fc58-41a9-919f-b637c0ee0654"}],"id":"f3ddd9c5-b442-422b-bd9a-34bed765e0ee","_postman_id":"f3ddd9c5-b442-422b-bd9a-34bed765e0ee","description":""}],"id":"e112e7f7-c3ca-419f-8ff8-ed4369149b44","_postman_id":"e112e7f7-c3ca-419f-8ff8-ed4369149b44","description":""},{"name":"/EDI","item":[{"name":"/Radley","id":"cdb24d3a-88f6-4a78-95da-e3ae91dff6ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Used to import EDI transactions directly into Odyssey by accepting a single xml file containing the transactions to be imported. You must attach the file as the content of a multipart/form-data request.
\n","urlObject":{"path":["EDI","Radley"],"host":["https://api.blinfo.com/company"],"query":[{"description":{"content":"CompanyID to import the records into.
\n","type":"text/plain"},"key":"CompanyID","value":null}],"variable":[]}},"response":[],"_postman_id":"cdb24d3a-88f6-4a78-95da-e3ae91dff6ff"}],"id":"031c9f2f-4882-4ac4-813f-aa64ee6a26c7","description":"The EDI endopints are used to communicate e-commerce requesets and transactions to Odyssey EDI tables.
This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"This endpoint will return your email signature.
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\n","urlObject":{"path":["Email","Signature"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"89333e3f-1864-4dce-913a-7697be091deb"},{"name":"{PUT}","id":"ffbba7cd-6eeb-4b46-aa18-0f2b8fcd5116","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Austin Brown
B&L Information Systems
www.blinfo.com
This endpoint will update your email signature. Leave your signature blank to \"erase\" it
\nThe body of your request should contain a JSON object with the following properties.
\nSignature - Type string :\nYour email signature. Leave this blank to \"erase\" your signature
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nAPIKey - Type string :\nThe optional APIKey used to authenticate this request. If not specified here, it must be specified in the X-API-Key HTTP header
\n","urlObject":{"path":["Email","Signature"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"ffbba7cd-6eeb-4b46-aa18-0f2b8fcd5116"}],"id":"3d9a9e1f-5f21-4b79-8c40-59c9f6cd037c","_postman_id":"3d9a9e1f-5f21-4b79-8c40-59c9f6cd037c","description":""},{"name":"/Contacts","item":[{"name":"{GET}","id":"d14d965e-0c0e-4b30-89ad-09c97e64c696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"This endpoint will return a list of email contacts based on the optional SearchText. It will only ever return up to 1,000 records that matched the given search critiera. Please specify \"SearchText\" if you wish to narrow your results, or find specific records if more than 1,000 are being returned.
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nSearchText - Type string :\nThis text will be searched for in the \"Email Address\" or \"Contact Name\" fields
\n","urlObject":{"path":["Email","Contacts"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"SearchText","value":"Austin"}],"variable":[]}},"response":[],"_postman_id":"d14d965e-0c0e-4b30-89ad-09c97e64c696"}],"id":"4f780c90-6be4-40e2-94a8-9395bdc3d754","_postman_id":"4f780c90-6be4-40e2-94a8-9395bdc3d754","description":""},{"name":"{POST} (with files)","id":"3e1e7830-33ae-4f12-a4a7-7e09597bded5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"This procedure allows you to send an email through Odyssey with or without attachments
\nThis request must be sent with \"multipart/form-data\" encoding to allow attachments to be uploaded. If not using attachments, you can send a normal, JSON request to the API to send an email.
\nIf you are uploading attachments, you can simply add them as files to your request, and the API will automatically collect all files sent and attach them to the outgoing email.
\nIn either case, the following properties can or must be used when sending emails.
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nAPIKey - Type string :\nThe optional APIKey used to authenticate this request. If not specified here, it must be specified in the X-API-Key HTTP header
\nTo - Type string :\nThe list of email addresses to send this email to. Email Addresses should be comma separated in this list.
\nCC - Type string :\nThe list of email addresses to CC this email to. Email Addresses should be comma separated in this list.
\nSubject - Type string :\nThe subject of this email
\nBody - Type string :\nThe content of this email
\nOdysseyFiles - Type string :\nA list of fully qualified paths to files that exist in Odyssey's file system. If files are provided here, they will be copied out of the filesystem and sent as attachments in this email
\n","urlObject":{"path":["Email"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e1e7830-33ae-4f12-a4a7-7e09597bded5"},{"name":"{POST} (without files)","id":"db40c148-a747-403f-9d00-e834a665ad26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"This procedure allows you to send an email through Odyssey with or without attachments
\nThis request must be sent with \"multipart/form-data\" encoding to allow attachments to be uploaded. If not using attachments, you can send a normal, JSON request to the API to send an email.
\nIf you are uploading attachments, you can simply add them as files to your request, and the API will automatically collect all files sent and attach them to the outgoing email.
\nIn either case, the following properties can or must be used when sending emails.
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nAPIKey - Type string :\nThe optional APIKey used to authenticate this request. If not specified here, it must be specified in the X-API-Key HTTP header
\nTo - Type string :\nThe list of email addresses to send this email to. Email Addresses should be comma separated in this list.
\nCC - Type string :\nThe list of email addresses to CC this email to. Email Addresses should be comma separated in this list.
\nSubject - Type string :\nThe subject of this email
\nBody - Type string :\nThe content of this email
\nOdysseyFiles - Type string :\nA list of fully qualified paths to files that exist in Odyssey's file system. If files are provided here, they will be copied out of the filesystem and sent as attachments in this email
\n","urlObject":{"path":["Email"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"db40c148-a747-403f-9d00-e834a665ad26"}],"id":"7a60d719-0c7a-4b7e-846b-b99c8c088218","_postman_id":"7a60d719-0c7a-4b7e-846b-b99c8c088218","description":""},{"name":"/Equipment","item":[{"name":"/RepairParts","id":"771b5b9a-9151-453b-b54e-bec8ee21cc91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Finds up to 1,0000 Repair Parts that match the specified search text
\nCompanyID - Type string :\nThe optional CompanyID to authenticate your request to the API
\nSearchText - Type string :\nThe optional search term to find repair parts whose equipment matches the given value. If a value is provided, we will use a \"MATCHES\" search on the MainDB.EQParts.Equipment field to find all repair parts whose Equipment value MATCHES the specified search text. If a value is not provided, all records up to the maxmimum will be returned.
\n","urlObject":{"path":["Equipment","RepairParts"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"SearchText","value":"FORKLIFT1"}],"variable":[]}},"response":[],"_postman_id":"771b5b9a-9151-453b-b54e-bec8ee21cc91"},{"name":"/{Equipment}/RepairParts","id":"805514e3-c216-43da-82d3-d5949612cbd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Finds up to the first 1,000 Repair Parts for the given piece of Equipment specified in the URL path.
\nCompanyID - Type string :\nThe optional CompanyID to authenticate your request to the API
\n","urlObject":{"path":["Equipment","FORKLIFT1","RepairParts"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"805514e3-c216-43da-82d3-d5949612cbd2"},{"name":"{GET}","id":"a2e43e19-22ce-4e41-bc30-1bd63d744701","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Finds up to 1,0000 pieces of Equipment that match the specified search text
\nCompanyID - Type string :\nThe optional CompanyID to authenticate your request to the API
\nSearchText - Type string :\nThe optional search term search for specific pieces of equipment. If a value is provided, we will use a \"MATCHES\" search on the MainDB.Equipment.Equipment and MainDB.Equipment.Description fields to find all pieces of equipment where the Equipment OR Description MATCHES the specified search text.
\nIf a value is not provided, all records up to the maxmimum will be returned.
\n","urlObject":{"path":["Equipment",""],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"SearchText","value":"FORK"}],"variable":[]}},"response":[],"_postman_id":"a2e43e19-22ce-4e41-bc30-1bd63d744701"},{"name":"/{Equipment}","id":"3656b5e4-6e1c-452c-98fc-30e29e539962","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Find an active piece of Equipment by the name specified in the URL path
\nCompanyID - Type string :\nThe optional CompanyID to authenticate your request to the API
\n","urlObject":{"path":["Equipment","FORKLIFT1"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"3656b5e4-6e1c-452c-98fc-30e29e539962"}],"id":"3feca522-3194-4142-881b-36abbdda0a24","_postman_id":"3feca522-3194-4142-881b-36abbdda0a24","description":""},{"name":"/FetchData","item":[{"name":"/ABL","id":"55ff6a7a-7830-4c38-a13c-fdee82eb77fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TableName\": \"Employees\",\n \"ABLQuery\": \"Active = true\",\n \"Sort\": \"ClockNumber\",\n \"FieldList\": \"ClockNumber,Badge,Name\",\n \"CompanyID\": \"ODSY\"\n}"},"url":"https://api.blinfo.com/company/FetchData/ABL","description":"This method allows you to specify a native Progress ABL query to fetch data. The ABL query must be a fully formed and syntactically valid ABL where clause. If the where clause contains CompanyID, then the query can span one or more companies. If CompanyID is not specified, then the query will only look in the company that you are logged into.
Dates within the where clause must be in MM/DD/YY format
\nTableName - Type String :
The name of the Odyssey table from which you wish to return data.
ABLQuery - Type String :
A fully formed and syntactically correct ABL where clause. This should not include the sort criteria as that is specified separately.
Sort - Type String :
A list of fields that define the order that the record will be returned. This must conform to the ABL sort criteria.
FieldList - Type String :
A comma-separated list of fields for which you are to receive data. If left blank, all fields in the table will be included in the return data set. If you specify only those fields that you want to see, the query will run faster and more efficiently.
CompanyID - Type String :
This is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CompanyID\": \"ODSY\",\n \"DataView\": \"OODAPITest\",\n \"ParameterList\": [\n {\n \"FieldName\": \"maindb.products.product\",\n \"Operator\": \">=\",\n \"ParameterValue\" : \"b\"\n }\n\t]\n}"},"url":"https://api.blinfo.com/company/FetchData/DataView","description":"This method will run the specified data view and return the resulting data. All records, regardless of the batch size defined in the data view, will be returned.
\nDates parameters must be in the same format as Odyssey is configured. If Odyssey’s system configuration for date format is DMY, then dates must be in DD/MM/YY format. Dates can also be separated by a back slash (), forward slash (/), dash (-), or a period (.).
\nDataView - Type String :
This identifies the name of the Data View to run. It must exist in the same company that you logged into.
ParameterList - Type List of DataViewParameter :
A list of DataViewParameter's that define the parameters you're passing to the data view. Each Parameter name must be fully qualified using periods to separate the database, table, and field names (e.g. maindb.orderitem.customer). If your parameter is defined as a filter with multiple values, those different values can be specified by separating them with a tilde (~) (e.g. \"FieldName\": \"maindb.orderitem.groupcode\", \"Operator\": \"Between\", “ParameterValue\": \"GRP1~GRP2”).
CompanyID - Type String :
This is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This allows you to send and receive data as JSON.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"SQLQuery\": \"SELECT TOP 5 * FROM Employees\",\n \"Page\": 1,\n \"BatchSize\": 5,\n \"CompanyID\": \"ODSY\"\n}"},"url":"https://api.blinfo.com/company/FetchData/SQL","description":"This method will allow you to return data from Odyssey using SQL-92 syntax.
\nThis method uses the same ODBC connectivity as Crystal Reports and will use the PUB username and password as defined in Odyssey.
Dates within the where clause must be in MM/DD/YY format.
\nSQLQuery - Type String : \nThis is a fully formed and fully qualified SQL query that conforms to SQL-92 syntax. The tables specified and the field specified in the SQL statement must exist as defined in the database in order for the query to work.
\nPage - Type Integer : \nIf you only want to return a subset of records, you can identify which page of records to return. If this is 0, then all records from the database table specified in the SQL query are returned.
\nSort - Type String : \nA list of fields that define the order that the record will be returned. This must conform to the ABL sort criteria.
\nBatchSize - Type Integer : \nA comma-separated list of fields for which you are to receive data. If left blank, all fields in the table will be included in the return data set. If you specify only those fields that you want to see, the query will run faster and more efficiently.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["FetchData","SQL"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"b040a84f-3feb-485d-b7e1-916246edf49b"},{"name":"/SQLasXML","id":"0de753d4-7dbd-43a4-b30a-749ff4feaddd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This allows you to send and receive data as JSON.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"SQLQuery\": \"SELECT TOP 5 * FROM Employees\",\n \"Page\": 1,\n \"BatchSize\": 5,\n \"CompanyID\": \"ODSY\"\n}"},"url":"https://api.blinfo.com/company/FetchData/SQLasXML","description":"The response will contain an XML document.
\nThis method will allow you to return data from Odyssey using SQL-92 syntax.
\nThis method uses the same ODBC connectivity as Crystal Reports and will use the PUB username and password as defined in Odyssey.
Dates within the where clause must be in MM/DD/YY format.
\nSQLQuery - Type String : \nThis is a fully formed and fully qualified SQL query that conforms to SQL-92 syntax. The tables specified and the field specified in the SQL statement must exist as defined in the database in order for the query to work.
\nPage - Type Integer : \nIf you only want to return a subset of records, you can identify which page of records to return. If this is 0, then all records from the database table specified in the SQL query are returned.
\nBatchSize - Type Integer : \nA comma-separated list of fields for which you are to receive data. If left blank, all fields in the table will be included in the return data set. If you specify only those fields that you want to see, the query will run faster and more efficiently.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["FetchData","SQLasXML"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"0de753d4-7dbd-43a4-b30a-749ff4feaddd"}],"id":"06c791ed-0164-4f74-b80f-cb90bd499913","description":"This FetchDataController provides various ways to fetch data from Odyssey.
\n","_postman_id":"06c791ed-0164-4f74-b80f-cb90bd499913"},{"name":"/FileSystem","item":[{"name":"/File","item":[{"name":"{GET}","id":"c7461076-a513-432c-972a-74311b595330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/FileSystem/File?Path=[LINKS]/01fig02.jpg&PublicKey=This endpoint allows you to fetch an Image from the system using the ImageKey. \nThis will return the raw binary data for an image, allowing it to be embedded into an application that can display images.
\nImageKey - Type string :\nThe unique, encrypted identifier for this image
\nPublicKey - Type string :\nThe public part of your API Key, if it is not provided in the X-API-Key Header. This parameter is optional. You should never pass your private, un-encrypted APIKey to this parameter.
\nCompanyID - Type String : \nThis optional parameter defines the CompanyID to use for APIKey validation, if using a global APIKey. If your APIKey was generated for a specific company, you do not have to supply this parameter.
\n","urlObject":{"path":["FileSystem","File"],"host":["https://api.blinfo.com/company"],"query":[{"key":"Path","value":"[LINKS]/01fig02.jpg"},{"description":{"content":"The public key that is generated by the client to access the API.
\n","type":"text/plain"},"key":"PublicKey","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Renames the given file.
\n","urlObject":{"path":["FileSystem","File","Rename"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4468bb5-e935-4212-8e01-8b49bce391f2"}],"id":"2a2b48e1-d775-4774-adcb-8486c26f46c2","_postman_id":"2a2b48e1-d775-4774-adcb-8486c26f46c2","description":""},{"name":"/Files","item":[{"name":"{GET}","id":"0cab82c0-9ba6-4a5b-aafa-dffceec0b129","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Gets the list of files that exist at the given path. If no path is provided, an error will be returned. A valid path must be specified
\nCompanyID - Type string :\nThe name of the Company to use to authenticate your API request. This is optional if using a company-specific API Key
\nPath - Type string :\nThe URL-encoded path to location which you wish to find files in
\n","urlObject":{"path":["FileSystem","Files"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"Path","value":"[LINKS]/AGB/Test"}],"variable":[]}},"response":[],"_postman_id":"0cab82c0-9ba6-4a5b-aafa-dffceec0b129"},{"name":"{POST}","id":"8297f2e4-99dc-4ec0-9f8f-1da846fc8bd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Uploads new files to the target path. In order for this request to work properly, you must attach files to it in the content of a multipart/form-data request.
\nCompanyID - Type string :\nThe name of the Company to use to authenticate your API request. This is optional if using a company-specific API Key
\nPath - Type string :\nThe URL-encoded path to location which you wish to find files in
\n","urlObject":{"path":["FileSystem","Files"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"Path","value":"[LINKS]/AGB/Test"}],"variable":[]}},"response":[],"_postman_id":"8297f2e4-99dc-4ec0-9f8f-1da846fc8bd6"},{"name":"{DELETE}","id":"62b614e2-4270-4c69-ad6c-117e9f86642d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Deletes the list of Odyssey files.
\n","urlObject":{"path":["FileSystem","Files"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"62b614e2-4270-4c69-ad6c-117e9f86642d"},{"name":"/Copy {POST}","id":"802afbfc-8aad-4e51-8b4e-cfcf64476947","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Copies the given list of files to the target path
\n","urlObject":{"path":["FileSystem","Files","Copy"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"802afbfc-8aad-4e51-8b4e-cfcf64476947"},{"name":"/Move {POST}","id":"304c9614-77f3-4a28-ab91-9a581874404e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Moves the given list of files to the target path
\n","urlObject":{"path":["FileSystem","Files","Move"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"304c9614-77f3-4a28-ab91-9a581874404e"}],"id":"8db148a2-e987-4c92-87d0-8baf6a3b6bd2","_postman_id":"8db148a2-e987-4c92-87d0-8baf6a3b6bd2","description":""},{"name":"/Folder","item":[{"name":"{POST}","id":"596f15a4-8854-4bfe-b6e1-0cc905d04098","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Creates a new Odyssey Folder
\n","urlObject":{"path":["FileSystem","Folder"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"596f15a4-8854-4bfe-b6e1-0cc905d04098"},{"name":"/Rename {POST}","id":"37ebb1dc-129b-49a4-9e03-2e0bacf15e83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Renames the given folder.
\n","urlObject":{"path":["FileSystem","Folder","Rename"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"37ebb1dc-129b-49a4-9e03-2e0bacf15e83"}],"id":"e56f4e12-98d7-4a78-8b6f-12817352b956","_postman_id":"e56f4e12-98d7-4a78-8b6f-12817352b956","description":""},{"name":"/Folders","item":[{"name":"{GET}","id":"7ac8c68f-0df1-4c49-a5d6-ceedd0a07a27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Gets the list of folders that exist at the given path. If no path is provided, the root location will be used.
\nCompanyID - Type string :\nThe name of the Company to use to authenticate your API request. This is optional if using a company-specific API Key
\nPath - Type string :\nThe URL-encoded path to location which you wish to find folders in. Leave blank for the 'root' level
\n","urlObject":{"path":["FileSystem","Folders"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"Path","value":"[LINKS]/AGB/Test"}],"variable":[]}},"response":[],"_postman_id":"7ac8c68f-0df1-4c49-a5d6-ceedd0a07a27"},{"name":"{DELETE}","id":"1e38b9df-eecc-45a5-b990-ff6fedb6be88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Deletes the list of Odyssey folders.
\n","urlObject":{"path":["FileSystem","Folders"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e38b9df-eecc-45a5-b990-ff6fedb6be88"},{"name":"/Copy {POST}","id":"d130a805-642b-4dee-b5f5-30a4a3baf985","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Copies the given list of folders to the target path
\n","urlObject":{"path":["FileSystem","Folders","Copy"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"d130a805-642b-4dee-b5f5-30a4a3baf985"},{"name":"/Move {POST}","id":"0ebf57b1-36b2-4c09-8e44-26513ef55cee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Moves the given list of folders to the target path
\n","urlObject":{"path":["FileSystem","Folders","Move"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ebf57b1-36b2-4c09-8e44-26513ef55cee"}],"id":"f39a30ac-d257-4f3e-9d5a-48457f8e8d61","_postman_id":"f39a30ac-d257-4f3e-9d5a-48457f8e8d61","description":""}],"id":"426f9cb8-07ff-4e8f-9794-f494a8c0abd0","_postman_id":"426f9cb8-07ff-4e8f-9794-f494a8c0abd0","description":""},{"name":"/GeneralCodes","item":[{"name":"/{CodeType} {GET}","id":"87b2f9fa-bddb-4c71-a30c-d9ac01a8b94c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"This endpoint will return a list of general codes matching the given type.It will only ever return up to 1,000 records that matched the given search critiera. Please specify \"SearchText\" if you wish to narrow your results, or find specific records if more than 1,000 are being returned.
\nCodeType - Type string :\nThe type of General Codes that you are looking for.
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nSearchText - Type string :\nThis text will be searched for in the \"CodeID\" or \"Description\" fields
\n","urlObject":{"path":["GeneralCodes","NOTY"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"SearchText","value":"type"}],"variable":[]}},"response":[],"_postman_id":"87b2f9fa-bddb-4c71-a30c-d9ac01a8b94c"}],"id":"7298a4e9-82b3-4af3-95aa-ff7e74d2c621","_postman_id":"7298a4e9-82b3-4af3-95aa-ff7e74d2c621","description":""},{"name":"/Help","item":[{"name":"/Asset","id":"1c73e44d-50d4-4c00-a426-673deb9f04dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/Help/Asset?AssetName=bundle.min.js","description":"Fetch a publicly-available Help asset (such as a CSS or JavaScript file) that is contained in the set of OODAPI Asset
\nAssetName - Type string :\nThe name of the asset to fetch. If not provided, it will return the document script by default.
\n","urlObject":{"path":["Help","Asset"],"host":["https://api.blinfo.com/company"],"query":[{"description":{"content":"The asset to request from the server.
\n","type":"text/plain"},"key":"AssetName","value":"bundle.min.js"}],"variable":[]}},"response":[],"_postman_id":"1c73e44d-50d4-4c00-a426-673deb9f04dd"},{"name":"/Category","id":"2e56a00f-af58-4806-9023-d7a0f76abcaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/Help/Category?DocCode=ODSYWHELP&CompanyID=ODSY","description":"Fetch a list of help categories for a company for a given document code.
\nDocCode - Type string :\nThe identifier for the group of categories you wish to retrieve
\nCompanyID - Type string :\nThe company for which you wish to find categories.
\n","urlObject":{"path":["Help","Category"],"host":["https://api.blinfo.com/company"],"query":[{"description":{"content":"The document code that groups together the desired help categories.
\n","type":"text/plain"},"key":"DocCode","value":"ODSYWHELP"},{"description":{"content":"The CompanyID for the help categories you wish to find.
\n","type":"text/plain"},"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"2e56a00f-af58-4806-9023-d7a0f76abcaf"},{"name":"/Category/CategoryID","id":"0bb2bd96-fa1b-4b21-ba9c-f133364ef5c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/Help/Category/OW691/Documents?DocCode=ODSYWHELP&CompanyID=ODSY","description":"Fetch a list of help documents for a given Category ID.
\nCategoryID - Type integer :\nThe Category ID for which you wish to find documents.
\nDocCode - Type string :\nThe identifier for the group of documents you wish to retrieve
\nCompanyID - Type string :\nThe company for which you wish to find documents.
\n","urlObject":{"path":["Help","Category","OW691","Documents"],"host":["https://api.blinfo.com/company"],"query":[{"description":{"content":"The document code that groups together the desired help categories.
\n","type":"text/plain"},"key":"DocCode","value":"ODSYWHELP"},{"description":{"content":"The CompanyID for the help categories you wish to find.
\n","type":"text/plain"},"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"0bb2bd96-fa1b-4b21-ba9c-f133364ef5c8"},{"name":"/Convert","id":"cbe55fa2-c32c-45f2-b24f-317a93997c40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This procedure allows you to upload a DOCX file and convert it to UTF-8 HTML.\nIf you're unable to upload form data in the form of a ConvertHelpRequest, you must add a Url Parameter named PublicKey this request. You must use this when using Public/Private key pairs.\nAdditionally, you may need to provide a Url Parameter named CompanyID to specify the company.
\nThis method should be constructed as a multipart/form-data request, and it should contain the file that you wish to convert. This file should be a Word .docx file.
DocCode - Type string :\nThe DocCode for the set of documents you're modifying
\nDocName - Type string :\nThe name of the document
\nUniqueID - Type string :\nThe unique ID of the document
\n","urlObject":{"path":["Help","Convert"],"host":["https://api.blinfo.com/company"],"query":[{"key":"PublicKey","value":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/Help/458?DocCode=ODSYWHELP&CompanyID=ODSY&PublicKey=Return a document based on the document identifier.
\nDocumentId - Type integer :\nThe unique ID of the document you're fetching.
\nDocCode - Type string :\nThe document code.
\nCompanyID - Type string :\nThe CompanyID you are logging into.
\nPublicKey - Type string :\nThis parameter is optional.
\nDocName - Type string :\nIf you provide a DocName, it will be used to search instead of the given unique ID
\nSearchWords - Type string :\nA list of search words to try to highlight in the document, comma separated
\nNoCache - Type boolean :\nWhether to ignore the cache for this request
\n","urlObject":{"path":["Help","458"],"host":["https://api.blinfo.com/company"],"query":[{"description":{"content":"The document code that groups together the desired help categories.
\n","type":"text/plain"},"key":"DocCode","value":"ODSYWHELP"},{"description":{"content":"The CompanyID for the help categories you wish to find.
\n","type":"text/plain"},"key":"CompanyID","value":"ODSY"},{"description":{"content":"The public key that is generated by the client to access the API.
\n","type":"text/plain"},"key":"PublicKey","value":"The name of the document to search for.
\n","type":"text/plain"},"key":"DocName","value":"Welcome"},{"description":{"content":"Words that will be searched against inside of a document.
\n","type":"text/plain"},"key":"SearchWords","value":"operation"}],"variable":[]}},"response":[],"_postman_id":"a9cdef02-d056-4b77-a024-c8717825c062"},{"name":"/Info","id":"e86a46e0-bdbd-4668-ab6b-4807839ddfd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This procedure allows you to find the UniuqeID of a document given its name, or it allows you to find the DocName of a document, give its UniuqeID.
\nUniqueID - Type integer :\nThe UniqueID of the document you're requesting information for
\nDocCode - Type string :\nThe DocCode you're requesting information for
\nDocName - Type string :\nThe name of the document you're requesting information for
\nIsSystem - Type boolean :\nWhether this is a system document. Set this to false when looking for Custom Help information. Set this to true when looking for System Help information.
\nAPIKey - Type string :\nA valid APIKey to authenticate access to the API.
\nCompanyID - Type string :\nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["Help","Info"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"e86a46e0-bdbd-4668-ab6b-4807839ddfd5"},{"name":"/RapidSupport/Link","id":"657add18-21a9-4502-b428-157b215e5570","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.blinfo.com/company/Help/RapidSupport/Link?CompanyID=ODSY","description":"Gets a temporary, encrypted link to Rapid Support
\nCompanyID - Type string :\nThe CompanyID you are going to login to Rapid Support with
\n","urlObject":{"path":["Help","RapidSupport","Link"],"host":["https://api.blinfo.com/company"],"query":[{"description":{"content":"The company ID for the user that is associated with the APIKey in the header of this request.
\n","type":"text/plain"},"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"657add18-21a9-4502-b428-157b215e5570"},{"name":"/RequestLock","id":"dc891fb2-974d-4a7d-a82c-21cdddce2a0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This procedure allows to request a document lock or unlock within the help system.\nLocking a help document will prevent other users from attempting to edit it while you are editing it. Unlocking a document is necessary when finished editing so that others may edit the document.
\nPlease note that when you log out of the Odyssey application, any active document locks that were generated by your UserID + CompanyID are removed.
\nUniqueID - Type integer :\nThe UniqueID of the document you're updating.
\nDocCode - Type string :\nThe DocCode you're updating
\nDocName - Type string :\nThe name of the document you're updating.
\nIsSystem - Type boolean :\nWhether this is a system document. Set this to false when requesting a lock/unlock for Custom Help. Set this to true when requesting a lock/unlock for System Help.
\nIsManagement - Type boolean :\nWhether this is a lock request for management of the structure of help, not just a single document.
\nRequestLock - Type boolean :\nWhether you're requesting a new lock in this request. The default is true. If this value is false, then the associated record will be unlocked.
\nAPIKey - Type string :\nA valid APIKey to authenticate access to the API.
\nCompanyID - Type string :\nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["Help","RequestLock"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc891fb2-974d-4a7d-a82c-21cdddce2a0c"},{"name":"/Search","id":"2d6d1ef3-c759-46fb-af3a-5c7be5315494","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/Help/Search?SearchPartsString=%7B%22Words%22%3A%5B%22labor%22%5D%2C%22Phrases%22%3A%5B%5D%7D&DocCode=ODSYWHELP&CompanyID=ODSY&PublicKey=Fetch a list of help documents that match the search strings for a company for a given document code.
\nSearchPartsString - Type string :\nThe JSON string version of a HelpSearchParts instance, containing an array of strings for \"Phrases\" and an array of strings for \"Words\".
\nDocCode - Type string :\nThe identifier for the group of categories you wish to retrieve
\nCompanyID - Type string :\nThe company for which you wish to find categories.
\nPublicKey - Type string :\nThis parameter should only be used with a temporary, encrypted API Key.
\n","urlObject":{"path":["Help","Search"],"host":["https://api.blinfo.com/company"],"query":[{"description":{"content":"The JSON string version of a HelpSearchParts instance
\n","type":"text/plain"},"key":"SearchPartsString","value":"%7B%22Words%22%3A%5B%22labor%22%5D%2C%22Phrases%22%3A%5B%5D%7D"},{"description":{"content":"The document code that groups together the desired help categories.
\n","type":"text/plain"},"key":"DocCode","value":"ODSYWHELP"},{"description":{"content":"The CompanyID for the help categories you wish to find.
\n","type":"text/plain"},"key":"CompanyID","value":"ODSY"},{"description":{"content":"The public key that is generated by the client to access the API.
\n","type":"text/plain"},"key":"PublicKey","value":"The name of the document to search for.
\n","type":"text/plain"},"key":"DocName","value":"Welcome"}],"variable":[]}},"response":[],"_postman_id":"2d6d1ef3-c759-46fb-af3a-5c7be5315494"},{"name":"/Search/{Page}","id":"c8590175-a932-4a73-ae7e-3eb35d02a71d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/Help/Search/1?SearchPartsString=%7B%22Words%22%3A%5B%22labor%22%5D%2C%22Phrases%22%3A%5B%5D%7D&DocCode=ODSYWHELP&CompanyID=ODSY&BatchSize=10&PublicKey=Fetch a specific page of help documents returned that match the search strings for a company for a given document code.
\nPageNumber - Type integer :\nThe current page of search results for the given query.
\nSearchPartsString - Type string :\nThe JSON string version of a HelpSearchParts instance, containing an array of strings for \"Phrases\" and an array of strings for \"Words\".
\nDocCode - Type string :\nThe identifier for the group of categories you wish to retrieve
\nCompanyID - Type string :\nThe company for which you wish to find categories.
\nBatchSize - Type integer :\nThe number of records to return at the given page.
\nPublicKey - Type string :\nThis parameter should only be used with a temporary, encrypted API Key.
\n","urlObject":{"path":["Help","Search","1"],"host":["https://api.blinfo.com/company"],"query":[{"description":{"content":"The JSON string version of a HelpSearchParts instance
\n","type":"text/plain"},"key":"SearchPartsString","value":"%7B%22Words%22%3A%5B%22labor%22%5D%2C%22Phrases%22%3A%5B%5D%7D"},{"description":{"content":"The document code that groups together the desired help categories.
\n","type":"text/plain"},"key":"DocCode","value":"ODSYWHELP"},{"description":{"content":"The Company ID for the help categories you wish to find.
\n","type":"text/plain"},"key":"CompanyID","value":"ODSY"},{"description":{"content":"The number of records to return at the given page.
\n","type":"text/plain"},"key":"BatchSize","value":"10"},{"description":{"content":"The public key that is generated by the client to access the API.
\n","type":"text/plain"},"key":"PublicKey","value":"The name of the document to search for.
\n","type":"text/plain"},"key":"DocName","value":"Welcome"}],"variable":[]}},"response":[],"_postman_id":"c8590175-a932-4a73-ae7e-3eb35d02a71d"},{"name":"/Update","id":"231ee95b-50f2-4e78-a13b-e293b35f92fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This procedure allows you to update the structure of documents in the help system based on DocCode. Please note that this is an advanced function and should only be performed under the supervision of B&L.
\nDocCode - Type string :\nThe DocCode for the set of documents you're modifying
\nCategories - Type Collection of UpdateHelpModel :\nThe new list of all categories.
\nDocuments - Type Collection of UpdateHelpModel :\nA list of documents that we have added, updated, or deleted.
\nAPIKey - Type string :\nA valid APIKey to authenticate access to the API.
\nCompanyID - Type string :\nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["Help","Update"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"231ee95b-50f2-4e78-a13b-e293b35f92fe"},{"name":"/UpdateDocument","id":"58ac05f5-b7dd-4cbf-852e-a3a9629222f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This procedure allows you to update the contents of a document in the help system. You can provide new UTF-8 HTML content for an existing document in the help system.
\nUniqueID - Type integer :\nThe UniqueID of the document you're updating.
\nDocCode - Type string :\nThe DocCode you're updating
\nDocName - Type string :\nThe name of the document you're updating.
\nDocBody - Type string :\nThe base64 encoded string version of the UTF-8 HTML content of the document.
\nIsSystem - Type boolean :\nWhether this is a system document
\nAPIKey - Type string :\nA valid APIKey to authenticate access to the API.
\nCompanyID - Type string :\nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["Help","UpdateDocument"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"58ac05f5-b7dd-4cbf-852e-a3a9629222f2"}],"id":"685a276b-33cc-4771-9b84-326dc5182c36","description":"Help endpoints are a collection of all the endpoints open for access to the Odyssey online help files. These are stored and curated withing the main database itself, and allow for searching for document key words, or a specific document via the OODAPI.
Certain endpoints require the use of a system generated PublicKey Key segment. The PublicKey is only for use within the Odyssey Help Application.
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/Image?ImageKey=abcdefg&PublicKey=This endpoint allows you to fetch an Image from the system using the ImageKey. \nThis will return the raw binary data for an image, allowing it to be embedded into an application that can display images.
\nImageKey - Type string :\nThe unique, encrypted identifier for this image
\nPublicKey - Type string :\nThe public part of your API Key, if it is not provided in the X-API-Key Header. This parameter is optional. You should never pass your private, un-encrypted APIKey to this parameter.
\nCompanyID - Type String : \nThis optional parameter defines the CompanyID to use for APIKey validation, if using a global APIKey. If your APIKey was generated for a specific company, you do not have to supply this parameter.
\n","urlObject":{"path":["Image"],"host":["https://api.blinfo.com/company"],"query":[{"key":"ImageKey","value":"abcdefg"},{"description":{"content":"The public key that is generated by the client to access the API.
\n","type":"text/plain"},"key":"PublicKey","value":"This controller allows you to fetch Images from the Odyssey system
\n","_postman_id":"6b6490ba-e64f-42c4-9fe5-1f8b055d473b"},{"name":"/Login","item":[{"name":"{POST}","id":"d81d5a3a-df3c-42a9-bd8a-e35029c9d7d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"This allows you to send and receive data as JSON.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Username\": \"user@blinfo.com\",\r\n \"Password\": \"password\",\r\n \"CompanyID\": \"ODSY\"\r\n}"},"url":"https://api.blinfo.com/company/Login","description":"Attempts to log the given user into the specified Company. If successful, you receive a temporary API Key that can be used to call other OODAPI procedures.
\nUsername - Type string :\nThe username of the user you're logging in for
\nPassword - Type string :\nThe password of the user you're logging in for
\nCompanyID - Type string :\nThe CompanyID of the company you're logging into
\n","urlObject":{"path":["Login"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"d81d5a3a-df3c-42a9-bd8a-e35029c9d7d9"},{"name":"/Companies","id":"d306bda3-27be-4fe2-91d8-7555ae14bfc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"This allows you to send and receive data as JSON.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Username\": \"user@blinfo.com\",\r\n \"Password\": \"password\"\r\n}"},"url":"https://api.blinfo.com/company/Login/Companies","description":"Gets a list of companies available to the given user/password combination. Will return an error if invalid credentials are supplied.
\nUsername - Type string :\nThe username of the user you're logging in for
\nPassword - Type string :\nThe password of the user you're logging in for
\n","urlObject":{"path":["Login","Companies"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"d306bda3-27be-4fe2-91d8-7555ae14bfc3"}],"id":"678c2c8f-f0c4-4d92-80cb-f0e2a2ac8965","description":"The EDI endopints are used to communicate e-commerce requesets and transactions to Odyssey EDI tables.
This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Creates a note within Odyssey for the given record.
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\nAPIKey - Type string :\nThe optional APIKey used to authenticate this request. If not specified here, it must be specified in the X-API-Key HTTP header
\nNoteType - Type string :\nThe General Codes \"Note Type\" for this note
\nTableName - Type string :\nThe fully-qualified name of the table that you are creating a note for. Example: MainDB.Contacts
\nDescription - Type string :\nThe \"description\" or \"title\" of this note
\nNote - Type string :\nThe content of this note
\nUniqueID - Type integer :\nThe UniqueID of the record you are creating a note for
\n","urlObject":{"path":["Note"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"a00a5dab-7b8f-4563-a000-008c993984d6"}],"id":"afca84ea-0ffc-42c7-bd04-3f4b9588298f","_postman_id":"afca84ea-0ffc-42c7-bd04-3f4b9588298f","description":""},{"name":"/OE","item":[{"name":"OETransaction","id":"cb539f57-a3b5-4f41-9157-e91bf7d30e23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This allows you to send and receive data as JSON.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"AutoCreate\": \"\",\r\n \"Comments\": \"\",\r\n \"CommRate\": \"\",\r\n \"CommRate2\": \"\",\r\n \"CommType\": \"\",\r\n \"CommType2\": \"\",\r\n \"Consignee\": \"\",\r\n \"ConsLocation\": \"\",\r\n \"ConsLocType\": \"\",\r\n \"ConsQty\": \"\",\r\n \"CurrCode\": \"\",\r\n \"Customer\": \"\",\r\n \"CustPart\": \"\",\r\n \"DiscountPct\": \"\",\r\n \"FreightCode\": \"\",\r\n \"GroupCode\": \"\",\r\n \"InternalInterfaceID\": \"\",\r\n \"ItemRevision\": \"\",\r\n \"OClass\": \"\",\r\n \"OrderDate\": \"\",\r\n \"POLine\": \"\",\r\n \"PoundsOrdered\": \"\",\r\n \"Product\": \"\",\r\n \"PurchasedCasting\": \"\",\r\n \"Qty\": \"\",\r\n \"ReleaseDate\": \"\",\r\n \"ReleaseType\": \"\",\r\n \"Revision\": \"\",\r\n \"Salesman\": \"\",\r\n \"Salesman2\": \"\",\r\n \"SellPrice\": \"\",\r\n \"ShipTo\": \"\",\r\n \"ShipVia\": \"\",\r\n \"StopCode\": \"\",\r\n \"SupplierID\": \"\",\r\n \"TermCode\": \"\",\r\n \"ToolOrderItem\": \"\",\r\n \"ToolOrderNumber\": \"\",\r\n \"UnitMeas\": \"\",\r\n \"APIKey\": \"\",\r\n \"CompanyID\": \"ODSY\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blinfo.com/company/OE/OETransaction","description":"Allows for importing into the A/P Transactions (APTransactions) table to easily create invoices from a source outside of Odyssey
\nAutoCreate - Type Boolean:
\nThis flag determines whether the order is auto created or not
\nComments - Type String:
\nComments entered here will become a comment on the order item once it is created.
\nCommRate - Type Decimal:
\nThe commission rate paid to this salesman for this product.
\nCommRate2 - Type Decimal:
\nThe commission rate paid to this salesman for this product.
\nCommType - Type String:
\nDesignates how the commission is going to be calculated (P=Percent based, D=$ Per Piece).
\nCommType2 - Type String:
\nDesignates how the commission is going to be calculated (P=Percent based, D=$ Per Piece).
\nConsignee - Type String:
\nConsignee associated with this order item.
\nConsLocation - Type String:
\nDefault consignment location for the item, which will be blank if this item is not a consignment item.
\nConsLocType - Type String:
\nThis is the default consignment location type (I=Ship now/Bill Later - In-house, S=Ship now/Bill later - Customer Site, B=Bill now/Ship later - In house, or Blank- Not consignment).
\nConsQty - Type Integer:
\nTotal quantity in consignment for this item.
\nCurrCode - Type String:
\nDefines the currency for this order.
\nCustomer - Type String:
\nCustomer associated with this ship-to.
\nCustPart - Type String:
\nThe customer's part number for the product being ordered.
\nDiscountPct - Type Decimal:
\nDiscount percent for this item.
\nFreightCode - Type String:
\nFreight code indicating the shipping terms for this order.
\nGroupCode - Type String:
\nUser defined grouping code assigned to this order item.
\nInternalInterfaceID - Type String:
\nThis field is used internally with intellichief as a unique identifier.
\nItemRevision - Type String:
\nUser maintained revision used to indicate the number of changes to this item.
\nOClass - Type String:
\nDefines the classification type of this order.
\nOrderDate - Type String:
\nThe date of the customer order.
\nPOLine - Type String:
\nPO Line number information associated with this item.
\nPoundsOrdered - Type Decimal:
\nNumber of pounds ordered for this item.
\nProduct - Type String:
\nDefines the product being ordered.
\nPurchasedCasting - Type Boolean:
\nOrder is for a purchased casting (yes) or a produced casting (no)
\nQty - Type Integer:
\nThe quantity of the order
\nReleaseDate - Type String:
\nThe promised date for shipment of corresponding release quantity.
\nReleaseType - Type String:
\nUser defined order type for this release.
\nRevision - Type String:
\nProduct's drawing revision level for this order item.
\nSalesman - Type String:
\nFirst salesman assigned to this product.
\nSalesman2 - Type String:
\nThe second salesman assigned to this product.
\nSellPrice - Type Decimal:
\nSelling price for this order item.
\nShipTo - Type String:
\nThe ship-to address where this order is to be shipped.
\nShipVia - Type String:
\nCarrier for this order.
\nStopCode - Type String:
\nReason this order item is stopped.
\nSupplierID - Type String:
\nDesignates the outside supplier that will direct ship this item.
\nTermCode - Type String:
\nPayment terms code for this order.
\nToolOrderItem - Type Integer:
\nThis designates that this order item is a sample order for the tool order item number displayed.
\nToolOrderNumber - Type Integer:
\nThis designates this order item is a sample order for the tool order number displayed.
\nUnitMeas - Type String:
\nSelling unit of measure.
\n","urlObject":{"path":["OE","OETransaction"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb539f57-a3b5-4f41-9157-e91bf7d30e23"}],"id":"72c7c8e0-dc7c-4346-bc14-d6230aa5afaf","_postman_id":"72c7c8e0-dc7c-4346-bc14-d6230aa5afaf","description":""},{"name":"/Operations","item":[{"name":"{GET}","id":"8082405c-779b-4129-b876-cb2441ce1a2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","value":"Gets active operations for the CompanyID associated with your APIKey (or if using an 'All Companies' APIKey - the CompanyID specified in the URL) This will only return the first 2000 active operations matching your search criteria.
\nSearchText - Type string :\nThis text will be searched for in the \"Operations\" field
\nCompanyID - Type string :\nThe optional CompanyID used to authenticate this request
\n","urlObject":{"path":["Operations"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"SearchText","value":""}],"variable":[]}},"response":[],"_postman_id":"8082405c-779b-4129-b876-cb2441ce1a2e"}],"id":"cf20d54d-cada-4d56-85e0-931383263821","_postman_id":"cf20d54d-cada-4d56-85e0-931383263821","description":""},{"name":"/Print","item":[{"name":"{GET}","id":"6db48d97-d268-44fc-b3a5-fa6c6ab3612c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-API-Key","value":"This method allows you to run a report and have it emailed as a PDF document after it has been generated. The list of parameters must include every parameter that the report is expecting to use, otherwise the report will generate an error and not run. Even if the value of a parameter is blank, it still must be included in the list of parameters. If you don’t specify CompanyID as one of your parameters, you can only run reports in the company that you are logged into. Report Series, and the Company override to determine which report to run will be determined based on the company that you log into and not the company that you specify as a parameter.
\nYou must provide all parameters that are defined in your Crystal Report - even those which are blank or left as their default values. This example shows how to run the PC7200, Scrap Analysis by Reason report. Even some of the report parameters which are filled in by Odyssey's interface must be supplied when running the report through the Odyssey API.
\nReport - Type string :\nThe name of the report you are running.
\nParameterList - TypeList :\nThe list of report parameters that a user can provide. See below for a description of the ReportParameter object.
\nEmailTo - Type string :\nThis is a list of comma, or semi-colon separated email addresses.
\nSubject - Type string :\nThis will be the subject of the email.
\nBody - Type string :\nThis specifies the body or content of the email.
\nCompanyID - Type string :\nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\nParameterName - Type string :\nThe name of this parameter in the report.
\nParameterValue - Type string :\nThe value of the parameter in the report.
\nParameterDataType - Type string :\nThe DataType for this parameter in the report.
\n","urlObject":{"path":["Report","Email"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a5eec55-011e-4400-8edb-85d185c0ad1c"}],"id":"b005539a-d3ad-4fec-aa08-07c246cf2581","_postman_id":"b005539a-d3ad-4fec-aa08-07c246cf2581","description":""},{"name":"/Production","item":[{"name":"/JobOn","item":[{"name":"/MoldCast","id":"7b60a03b-a2b2-4541-a83e-1fe41b7afd81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyID\": \"ODSY\",\r\n \"ClockNumber\": \"215\",\r\n \"DateFormat\": \"MDY\",\r\n \"Data\": {\r\n \t\"OrderNumber\" : \"21854\",\r\n \"OrderItem\": \"1\",\r\n \"OrderType\": \"S\",\r\n \"Operation\" : \"MOLD\",\r\n \"Product\" : \"R4512\",\r\n \"Tool\" : \"R4512\",\r\n \"ShiftDate\" : \"02/07/2020\",\r\n \"Quantity\": \"0\",\r\n\t\"Hours\": \"3\",\r\n\t\"ShiftName\": \"1\",\r\n\t\"Remarks\": \"Test from the Odyssey API\"\r\n }\r\n}"},"url":"https://api.blinfo.com/company/Production/JobOn/MoldCast","description":"The JobOn/MoldCast endpoint allows you to \"job on\" an employee to a job that is performing a 33, MoldCast operation.
\nIn order to use this method, you must be authorized for both the Odyssey API module and the Production Interface module.
\nClockNumber - Type integer :\nThe Clock Number of the Employee jobbing on.
\nDateFormat - Type String : \nThe DateFormat that should be used when providing date values to Odyssey.
\nValid options are:
\nData - Type Object :\nThe ProductionTran record to submit to Odyssey. Any ProductionTran field, or User Defined Field in ProductionTran can be supplied in this record. Data supplied in this record is validated through standard production entry logic. Please see the Production Entry Scope document for detailed information on required fields.
Success - Type boolean :\nReturns true if the job was able to be jobbed onto.
\nErrorMessage - Type string :\nThe error message that was returned by the system, if any was present.
\nJobOnUniqueID - Type integer :\nThe UniqueID of the ProductionTran record that was created, if this JobOn submission was successful.
\nAttempted - Type integer :\nIf your job on parameters were entered, this value should always be 1, to indicate that the system attempted to job on with a single record.
\nSuccessful - Type integer :\nIf your job on was successful, this value should be 1. Otherwise, 0 indicates that the job on was not successful.
\nLogging - Type Collection of EntryLogging :\nIf an error message was generated during this job on operation, this will contain one entry for the error that was generated from your production record.
An EntryLogging object contains the following fields:
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyID\": \"ODSY\",\r\n \"ClockNumber\": \"215\",\r\n \"DateFormat\": \"MDY\",\r\n \"Data\": {\r\n \t\"OrderNumber\" : \"21854\",\r\n \"OrderItem\": \"1\",\r\n \"OrderType\": \"S\",\r\n \"Operation\" : \"GRIND\",\r\n \"Product\" : \"R4512\",\r\n \"ShiftDate\" : \"02/07/2020\",\r\n\t\"Hours\": \"3\",\r\n\t\"ShiftName\": \"1\",\r\n\t\"Remarks\": \"Test JobOn/Secondary from the Odyssey API\"\r\n }\r\n}"},"url":"https://api.blinfo.com/company/Production/JobOn/Secondary","description":"The JobOn/Secondary endpoint allows you to \"job on\" an employee to a job that is performing a 43, Secondary operation.
\nIn order to use this method, you must be authorized for both the Odyssey API module and the Production Interface module.
\nClockNumber - Type integer :\nThe Clock Number of the Employee jobbing on.
\nDateFormat - Type String : \nThe DateFormat that should be used when providing date values to Odyssey.
\nValid options are:
\nData - Type Object :\nThe ProductionTran record to submit to Odyssey. Any ProductionTran field, or User Defined Field in ProductionTran can be supplied in this record. Data supplied in this record is validated through standard production entry logic. Please see the Production Entry Scope document for detailed information on required fields.
Success - Type boolean :\nReturns true if the job was able to be jobbed onto.
\nErrorMessage - Type string :\nThe error message that was returned by the system, if any was present.
\nJobOnUniqueID - Type integer :\nThe UniqueID of the ProductionTran record that was created, if this JobOn submission was successful.
\nAttempted - Type integer :\nIf your job on parameters were entered, this value should always be 1, to indicate that the system attempted to job on with a single record.
\nSuccessful - Type integer :\nIf your job on was successful, this value should be 1. Otherwise, 0 indicates that the job on was not successful.
\nLogging - Type Collection of EntryLogging :\nIf an error message was generated during this job on operation, this will contain one entry for the error that was generated from your production record.
An EntryLogging object contains the following fields:
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyID\": \"ODSY\",\r\n \"DateFormat\": \"MDY\",\r\n \"DataList\": [\r\n {\r\n\t\t\"Hours\": \"1\",\r\n \t\"Equipment\": \"ABEQUIP-1\",\r\n \t\"Operation\" : \"ABGRIND\",\r\n \t\"ReasonCode\": \"01\",\r\n \t\"ShiftDate\": \"02/08/2020\",\r\n \t\"Remarks\": \"Test from Production/Entry/Downtime from the Odyssey API\"\r\n }\r\n ]\r\n}"},"url":"https://api.blinfo.com/company/Production/Entry/Downtime","description":"The Entry/Downtime endpoint allows you to submit a non-jobbing production entry for an 04, Downtime operation.\nIn order to use this method, you must be authorized for both the Odyssey API module and the Production Interface module.
\nDateFormat - Type String : \nThe DateFormat that should be used when providing date values to Odyssey.
\nValid options are:
\nDataList - Type Collection of Object :\nA list of all the production transaction records to submit to Odyssey. Any ProductionTran field, or User Defined Field in ProductionTran can be supplied in this list. Data supplied in this list is validated through standard production entry logic. Please see the Production Entry Scope document for detailed information on required fields.
CompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\nSuccess - Type boolean :\nReturns true if there were no errors generated during the processing of your production records.
\nErrorMessage - Type string :\nThe error message that was returned by the system, if any was present.
\nAttempted - Type integer :\nThe number of production records that were attempted to be processed.
\nSuccessful - Type integer :\nThe number of production records that were successfully processed.
\nLogging - Type Collection of EntryLogging :\nIf errors were generated during the processing of your production records, this collection of errors will contain an entry for each error.
An EntryLogging object contains the following fields:
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyID\": \"ODSY\",\r\n \"DateFormat\": \"MDY\",\r\n \"DataList\": [\r\n {\r\n \t\"OrderNumber\" : \"21854\",\r\n \t\"OrderItem\": \"1\",\r\n \t\"OrderType\": \"S\",\r\n \t\"Operation\" : \"MOLD\",\r\n \t\"Product\" : \"R4512\",\r\n \t\"Tool\" : \"R4512\",\r\n \t\"ShiftDate\" : \"02/07/2020\",\r\n \t\"Qty\": \"2\",\r\n \t\"Hours\": \"3\",\r\n \t\"ShiftName\": \"1\",\r\n \t\"Remarks\": \"Test from Production/Entry/MoldCast from the Odyssey API\"\r\n }\r\n ]\r\n}"},"url":"https://api.blinfo.com/company/Production/Entry/MoldCast","description":"The Entry/MoldCast endpoint allows you to submit a non-jobbing production entry for a 33, MoldCast operation.\nIn order to use this method, you must be authorized for both the Odyssey API module and the Production Interface module.
\nDateFormat - Type String : \nThe DateFormat that should be used when providing date values to Odyssey.
\nValid options are:
\nDataList - Type Collection of Object :\nA list of all the production transaction records to submit to Odyssey. Any ProductionTran field, or User Defined Field in ProductionTran can be supplied in this list. Data supplied in this list is validated through standard production entry logic. Please see the Production Entry Scope document for detailed information on required fields.
CompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\nSuccess - Type boolean :\nReturns true if there were no errors generated during the processing of your production records.
\nErrorMessage - Type string :\nThe error message that was returned by the system, if any was present.
\nAttempted - Type integer :\nThe number of production records that were attempted to be processed.
\nSuccessful - Type integer :\nThe number of production records that were successfully processed.
\nLogging - Type Collection of EntryLogging :\nIf errors were generated during the processing of your production records, this collection of errors will contain an entry for each error.
An EntryLogging object contains the following fields:
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyID\": \"ODSY\",\r\n \"DateFormat\": \"MDY\",\r\n \"DataList\": [\r\n {\r\n \t\"OrderNumber\" : \"21854\",\r\n \t\"OrderItem\": \"1\",\r\n \t\"OrderType\": \"S\",\r\n \t\"Operation\" : \"GRIND\",\r\n \t\"Product\" : \"R4512\",\r\n \t\"ShiftDate\" : \"02/08/2020\",\r\n \t\"Qty\": \"2\",\r\n \t\"Hours\": \"3\",\r\n \t\"ShiftName\": \"1\",\r\n \t\"Remarks\": \"Test from Production/Entry/Secondary from the Odyssey API\"\r\n }\r\n ]\r\n}"},"url":"https://api.blinfo.com/company/Production/Entry/Secondary","description":"The Entry/Secondary endpoint allows you to submit a non-jobbing production entry for a 43, Secondary operation.\nIn order to use this method, you must be authorized for both the Odyssey API module and the Production Interface module.
\nDateFormat - Type String : \nThe DateFormat that should be used when providing date values to Odyssey.
\nValid options are:
\nDataList - Type Collection of Object :\nA list of all the production transaction records to submit to Odyssey. Any ProductionTran field, or User Defined Field in ProductionTran can be supplied in this list. Data supplied in this list is validated through standard production entry logic. Please see the Production Entry Scope document for detailed information on required fields.
CompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\nSuccess - Type boolean :\nReturns true if there were no errors generated during the processing of your production records.
\nErrorMessage - Type string :\nThe error message that was returned by the system, if any was present.
\nAttempted - Type integer :\nThe number of production records that were attempted to be processed.
\nSuccessful - Type integer :\nThe number of production records that were successfully processed.
\nLogging - Type Collection of EntryLogging :\nIf errors were generated during the processing of your production records, this collection of errors will contain an entry for each error.
An EntryLogging object contains the following fields:
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyID\": \"ODSY\",\r\n \"DateFormat\": \"MDY\",\r\n \"DataList\": [\r\n {\r\n \t\"OrderNumber\" : \"21854\",\r\n \t\"OrderItem\": \"1\",\r\n \t\"OrderType\": \"S\",\r\n \t\"Operation\" : \"ABGRIND\",\r\n \t\"ReasonCode\": \"LOST\",\r\n \t\"Product\" : \"R4512\",\r\n \t\"ShiftDate\" : \"02/08/2020\",\r\n \t\"Qty\": \"2\",\r\n \t\"Hours\": \"3\",\r\n \t\"ShiftName\": \"1\",\r\n \t\"Remarks\": \"Test from Production/Entry/Scrap from the Odyssey API\"\r\n }\r\n ]\r\n}"},"url":"https://api.blinfo.com/company/Production/Entry/Scrap","description":"The Entry/Scrap endpoint allows you to submit a non-jobbing production entry for a 34, Scrap operation.\nIn order to use this method, you must be authorized for both the Odyssey API module and the Production Interface module.
\nDateFormat - Type String : \nThe DateFormat that should be used when providing date values to Odyssey.
\nValid options are:
\nDataList - Type Collection of Object :\nA list of all the production transaction records to submit to Odyssey. Any ProductionTran field, or User Defined Field in ProductionTran can be supplied in this list. Data supplied in this list is validated through standard production entry logic. Please see the Production Entry Scope document for detailed information on required fields.
CompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\nSuccess - Type boolean :\nReturns true if there were no errors generated during the processing of your production records.
\nErrorMessage - Type string :\nThe error message that was returned by the system, if any was present.
\nAttempted - Type integer :\nThe number of production records that were attempted to be processed.
\nSuccessful - Type integer :\nThe number of production records that were successfully processed.
\nLogging - Type Collection of EntryLogging :\nIf errors were generated during the processing of your production records, this collection of errors will contain an entry for each error.
An EntryLogging object contains the following fields:
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"UniqueID\": \"\",\r\n \"Shots\": \"\",\r\n \"CompanyID\": \"ODSY\"\r\n}"},"url":"https://api.blinfo.com/company/Production/EndingShots","description":"Report ending shots to an existing jobbed-on production transaction.
\nUniqueID - Type integer :\nThe UniqueID of the jobbed on production record you're updating.
\nShots - Type integer :\nThe number of shots to report as the ending shots of a job.
\n","urlObject":{"path":["Production","EndingShots"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"b9592878-1224-4f77-87d2-2563ecf7ee13"},{"name":"/HourlyPunch","id":"c109402d-4005-41c3-ba18-f5c80ec84422","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"UniqueID\": \"\",\r\n \"TimeSlot\": \"\",\r\n \"Shots\": \"\",\r\n \"Qty\": \"\",\r\n \"ScrapQty\": \"\",\r\n \"ReasonCode\": \"\",\r\n \"CompanyID\": \"ODSY\"\r\n}"},"url":"https://api.blinfo.com/company/Production/HourlyPunch","description":"Perform an hourly punch against an existing jobbed-on production transaction.\nIn order to use this method, you must be authorized for both the Odyssey API module and the Production Interface module
\nUniqueID - Type integer :\nUnique ID of the jobbed-on production transaction that will be updated with an hourly punch
\nTimeSlot - Type integer :\nOptional timeslot to apply the production shots or quantity to.
\nShots - Type integer :\nOptional number of shots to report. If specified, quantity will be updated based on the current product number-on.
\nQuantity - Type integer :\nOptional number of pieces to report. If Shots is specified, Quantity is ignored.
\nScrapQty - Type integer :\nOptional number of pieces to report as scrap.
\nReasonCode - Type String :\nIf reporting scrap quantity, this is the reason code for the 34 transaction.
\nDate - Type String :\nOptional date that the hourly punch is being reported for. This must be in MMDDYYYY format. If not specified, the current system date will be used.
\nTime - Type String :\nOptional time that the hourly punch is being reported for. This must be in military time with a HHMMSS format. If not specified, the current system time will be used.
\nSuccess - Type boolean :\nReturns true if the request was successful.
\nErrorMessage - Type string :\nThe error message that was returned by the system, if any was present.
\nJobOnUniqueID - Type integer :\nThe UniqueID of the ProductionTran record that was created for the next jobbed-on record, if this HourlyPunch submission was successful
\nAttempted - Type integer :\nIf your HourlyPunch parameters were entered, this value should always be 1, to indicate that the system attempted to job on with a single record.
\nSuccessful - Type integer :\nIf your HourlyPunch on was successful, this value should be 1. Otherwise, 0 indicates that the HourlyPunch was not successful.
\nLogging - Type Collection of EntryLogging :\nIf an error message was generated during this job on operation, this will contain one entry for the error that was generated from your production record.
An EntryLogging object contains the following fields:
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"UniqueID\": \"\",\r\n \"Date\": \"\",\r\n \"Time\": \"\",\r\n \"Qty\": \"\",\r\n \"Shots\": \"\"\r\n}"},"url":"https://api.blinfo.com/company/Production/JobOff","description":"The /Production/JobOff endpoint allows you to \"job off\" an employee from a job.
\nIn order to use this method, you must be authorized for both the Odyssey API module and the Production Interface module
\nUniqueID - Type integer :\nThe UniqueID of the ProductionTran record you're jobbing off.
\nQty - Type integer :\nThe Quantity being reported for this transaction. Leave as 0 or omit this property if reporting Shots instead of Quantity.
\nShots - Type integer :\nThe Shots being reported for this transaction. Leave as 0 or omit this property if reporting Quantity instead of Shots.
\nDate - Type string :\nThe optional Date that the employee is jobbing off. (MMDDYYYY)
\nTime - Type string :\nThe optional Military Time that the employee is jobbing off. (HHMMSS)
\nSuccess - Type boolean :\nReturns true if there were no errors generated during the processing of your JobOff request.
\nErrorMessage - Type string :\nThe error message that was returned by the system, if any was present.
\nAttempted - Type integer :\nThe number of production records that were attempted to be processed. For this JobOff endpoint, this value should always be 1.
\nSuccessful - Type integer :\nThe number of production records that were successfully processed. For this JobOff endpoint, this value should always be 1 when successful, and 0 when not successful.
\nLogging - Type Collection of EntryLogging :\nIf errors were generated during the processing of your JobOff request, this collection of errors will contain an entry for each error.
An EntryLogging object contains the following fields:
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"UniqueID\": \"\",\r\n \"Shots\": \"\",\r\n \"CompanyID\": \"ODSY\"\r\n}"},"url":"https://api.blinfo.com/company/Production/StartingShots","description":"Report starting shots to an existing jobbed-on production transaction.
\nUniqueID - Type integer :
The UniqueID of the jobbed on production record you're updating.
Shots - Type integer :
The number of shots to report as the starting shots of a job.
The ProductionController provides functionality relating to Shot Reporting, Jobbing, and Clocking.
\nIn order to use any of these endpoints, you must have the Production Interface module.
\n","_postman_id":"492b8650-db32-4b4f-9328-728425fd23f4"},{"name":"/ProductionInterface","item":[{"name":"{POST}","id":"97266b3e-644b-43eb-a61a-285d80f67f94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyID\": \"ODSY\",\r\n \"InterfaceID\": \"PINTF\",\r\n \"ImportID\": \"33-STD\",\r\n \"DataList\": [\r\n {\r\n \t\"ShopOrder\" : \"21854-1\",\r\n \t\"Operation\" : \"MOLD\",\r\n \t\"Product\" : \"R4512\",\r\n \t\"ShiftDate\" : \"05/12/2020\",\r\n \t\"Quantity\": \"7\",\r\n \t\"Hours\": \"2\",\r\n \t\"Tool\" : \"R4512\",\r\n \t\"ShiftName\": \"1\",\r\n \t\"ScreenID\": \"AGB-SCRAP\"\r\n }\r\n ]\r\n}"},"url":"https://api.blinfo.com/company/ProductionInterface","description":"The /ProductionInterface endpoint allows you to import production records into Odyssey using the Production Interface module.
\nIn order to use this method, you must be authorized for both the Odyssey API module and the Production Interface module.
\nInterfaceID - Type String :
The unique identifier for this production interface.
The DateFormat on the Production Interface must be set to a value or errors can be encountered if a Date field is passed in the DataList.
\nValid options are:
\nImportID - Type String :
The ID of the import profile to run.
DataList - Type Collection of Object :
A list of all the data objects that will be used in the request.
CompanyID - Type String :
This is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
Success - Type boolean :
Returns true if there were no errors generated during the processing of your production records.
ErrorMessage - Type string :
The error message that was returned by the system, if any was present.
Attempted - Type integer :
The number of production records that were attempted to be processed.
Successful - Type integer :
The number of production records that were successfully processed.
Logging - Type Collection of EntryLogging :
If errors were generated during the processing of your production records, this collection of errors will contain an entry for each error.
An EntryLogging object contains the following fields:
The production interface endpoint is an advanced way of uploading production data into Odyssey. This can allow you to integrate third party devices or applications with your Odyssey data.
\nIn order to use this endpoint, you must have the Production Interface module.
\n","event":[{"listen":"prerequest","script":{"id":"1a62a2db-8501-45d4-b385-47a5d04dc2d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a210e241-be0e-4fcb-9c69-25afc5f0e0b5","type":"text/javascript","exec":[""]}}],"_postman_id":"91170b51-6026-46c6-a73e-a58546186ed0"},{"name":"/Production/Mobile","item":[{"name":"/Designer","item":[{"name":"/{ScreenID}","id":"55319f5e-bcf5-442c-a37d-faf7fb8e21e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Returns a brand new mobile transaction screen design based off the default system design for that screen type.
\nScreenID - Type string :\nThis value represents the ID of the screen you're designing. For example, MI1001 is ScreenID for Odyssey App Material Issues. This determines the design of the screen you get back.
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\n","urlObject":{"path":["Production","Mobile","Designer","MI1001"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"55319f5e-bcf5-442c-a37d-faf7fb8e21e3"},{"name":"/{ScreenID}?ScreenName=","id":"3e0eb773-ed46-4095-91b7-9657b66e6c12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Fetches a custom Odyssey App Transaction Screen design for use within the Odyssey App or to be submitted. This can be used to allow you to fetch an existing design in \"design mode\" so that you can continue modifying the design.
\nScreenID - Type string :\nThis value represents the ID of the screen you're fetching. For example, MI1001 is ScreenID for Odyssey App Material Issues. This determines the design of the screen you get back.
\nScreenName - Type string :\nThis name of the screen which you're fetching. This screen must exist within the specified company.
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\n","urlObject":{"path":["Production","Mobile","Designer","MI1001"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"ScreenName","value":"My Odyssey App Screen"}],"variable":[]}},"response":[],"_postman_id":"3e0eb773-ed46-4095-91b7-9657b66e6c12"},{"name":"{ScreenID}","id":"2c0319f4-6af0-4ef8-9f00-462299b467fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"Adds a new mobile transaction screen design. This allows you to create new screen designs for Odyssey App.
\nScreenID - Type string :\nThis value represents the ID of the screen you're creating. For example, if you're creating a Material Issues screen for Odyssey App, you'd supply a value of MI1001.
\nScreenName - Type string :\nThe name of the screen to be saved. This name must be unique for a given company and ScreenID.
\nFields - Type SaveFieldModel[] :\nThe list of fields that are included on the screen.
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\nThe SaveFieldModel represents all the information that can be passed for a field on a mobile production screen
\nFieldName - Type string :\nThe fully qualified name of this field separated by periods, e.g., MainDB.TableName.FieldName
LabelText - Type string :\nThe text to be displayed for this field.
\nDefaultValue - Type string :\nThe default value this field will contain.
\nSequence - Type integer :\nDetermines the order in which the field is displayed on the screen.
\nVisible - Type boolean :\nDetermines if this field is visible on the screen or not. The default is true, which means that a new field will, by default, by shown on the screen.
\nRequired - Type boolean :\nDetermines if a user must enter a value into this field during processing The default is false.
\nDefaultType - Type string :\nThe type of defaulting that will happen for this field on a Save+Add.\nPossible Values
\nRepeatValue - Carry the saved value over to the new add screen on a Save & AddStandard - Reset the field to the DefaultValue on a Save+AddUpdates an existing new mobile transaction screen design. This allows you to manage the new screen designs for Odyssey App.
\nScreenID - Type string :\nThis value represents the ID of the screen you're creating. For example, if you're creating a Material Issues screen for Odyssey App, you'd supply a value of MI1001.
\nScreenName - Type string :\nThe name of the screen to be updated. This must exactly match the screen you wish to update in the specified company. This value cannot be changed.
\nFields - Type SaveFieldModel[] :\nThe list of fields that are included on the screen.
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\nThe SaveFieldModel represents all the information that can be passed for a field on a mobile production screen
\nFieldName - Type string :\nThe fully qualified name of this field separated by periods, e.g., MainDB.TableName.FieldName
LabelText - Type string :\nThe text to be displayed for this field.
\nDefaultValue - Type string :\nThe default value this field will contain.
\nSequence - Type integer :\nDetermines the order in which the field is displayed on the screen.
\nVisible - Type boolean :\nDetermines if this field is visible on the screen or not. The default is true, which means that a new field will, by default, by shown on the screen.
\nRequired - Type boolean :\nDetermines if a user must enter a value into this field during processing The default is false.
\nDefaultType - Type string :\nThe type of defaulting that will happen for this field on a Save+Add.\nPossible Values
\nRepeatValue - Carry the saved value over to the new add screen on a Save & AddStandard - Reset the field to the DefaultValue on a Save+AddThis endpoint allows you to submit a mobile transaction such as Tag Entry or Material Transaction screen.
\nIn order to use this endpoint, you must first create a screen design using the Odyssey App Transaction Screen Designer in Odyssey or through he API.
\nScreenID - Type string :\nThis value represents the ID of the screen you're submitting. For example, if you're submitting Material Issue, you'd supply a value of MI1001.
\nScreenName - Type string :\nThe name of the screen design you're submitting. This is required for proper defaulting and validation.
\nData - Type dictionary :\nThe collection of fields and values you are submitting. Example:
\n{\n \"MainDB.MatlHist.Account\": \"1000\",\n \"MainDB.MatlHist.Clocknumber\": \"200\",\n \"MainDB.MatlHist.Date\": \"2021-10-31\",\n}\nNote - Dates must be formatted in the ISO8601 format with delimiters. This means, for example, that the date \"October 31, 2021\" would be passed as \"2021-10-31\".
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\n","urlObject":{"path":["Production","Mobile","Post","MI1001","Save"],"host":["https://api.blinfo.com/company"],"query":[{"key":"ScreenName","value":"My Odyssey App Screen"},{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"7604258e-719c-494c-a114-6857441d6038"},{"name":"{ScreenID}/SaveAndAdd?ScreenName","id":"fc3e13b9-063f-4327-b6f1-648624ce0787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"This endpoint allows you to submit a mobile transaction such as Tag Entry or Material Transaction screen and receive back the next list of values for use in a \"Save+Add\" manner.
\nIn order to use this endpoint, you must first create a screen design using the Odyssey App Transaction Screen Designer in Odyssey or through he API.
\nThis endpoint returns a collection of fields and values that can be used to populate the screen again.
\nScreenID - Type string :\nThis value represents the ID of the screen you're submitting. For example, if you're submitting Material Issue, you'd supply a value of MI1001.
\nScreenName - Type string :\nThe name of the screen design you're submitting. This is required for proper defaulting and validation.
\nData - Type dictionary :\nThe collection of fields and values you are submitting. Example:
\n{\n \"MainDB.MatlHist.Account\": \"1000\",\n \"MainDB.MatlHist.Clocknumber\": \"200\",\n \"MainDB.MatlHist.Date\": \"2021-10-31\",\n}\nNote - Dates must be formatted in the ISO8601 format with delimiters. This means, for example, that the date \"October 31, 2021\" would be passed as \"2021-10-31\".
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\n","urlObject":{"path":["Production","Mobile","Post","MI1001","SaveAndAdd"],"host":["https://api.blinfo.com/company"],"query":[{"key":"ScreenName","value":"My Odyssey App Screen"},{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"fc3e13b9-063f-4327-b6f1-648624ce0787"}],"id":"15759a11-9b18-46f5-bd26-101d6af1d4ee","_postman_id":"15759a11-9b18-46f5-bd26-101d6af1d4ee","description":""},{"name":"/Screens","item":[{"name":"{ScreenID}","id":"49a8259d-21bf-4636-b37e-bd90bc39a8b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Returns up to 1,000 matching, transaction screens that the user has access to grouped by type of transaction screen.
\nIf a search text value is provided, records will be returned where the ScreenID OR ScreenName match the given value (using a wild-card matches search).
\nSearchText - Type string :\nThis value, if supplied, will be used to filter your results. This value will be searched using a MATCHES operator on the ScreenID OR ScreenName fields
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\n","urlObject":{"path":["Production","Mobile","Screens"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"SearchText","value":""}],"variable":[]}},"response":[],"_postman_id":"49a8259d-21bf-4636-b37e-bd90bc39a8b0"},{"name":"{ScreenID}?ScreenName=","id":"7eaace30-1ac2-47ee-a5bd-d7cd709018ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Returns all the fields and data for an Odyssey App Transaction Screen needed in order to fill out the fields and submit a transaction. This can be used in a process where you would fetch all the visible fields on a screen, fill them out, then Post them using the Save or Save+Add endpoints.
\nScreenID - Type string :\nThis value represents the ID of the screen you're fetching. For example, if you're fetching Material Issue, you'd supply a value of MI1001.
\nScreenNamet - Type string :\nThe name of the screen you're fetching a design for. This screen must exist within the specified company.
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\n","urlObject":{"path":["Production","Mobile","Screens","MI1001"],"host":["https://api.blinfo.com/company"],"query":[{"key":"ScreenName","value":"My Odyssey App Screen"},{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"7eaace30-1ac2-47ee-a5bd-d7cd709018ae"}],"id":"485dfa39-b6ed-4413-ac5d-056b32a27aa7","_postman_id":"485dfa39-b6ed-4413-ac5d-056b32a27aa7","description":""}],"id":"5ae90aa7-19bb-42ea-a8c9-456bbe765a5c","description":"The /Production/Mobile set of endpoints allows you to perform various functions relating to Mobile production. Mobile production is designed in Odyssey and can be managed through the API. Mobile production transactions (Tag Entry and Material Transactions) can be submitted through the Odyssey App as well as the API.
\nThese endpoints are available as of Odyssey version 6.3.3.
\nYou do not need the Production Interface module in order to use these endpoints.
\n","_postman_id":"5ae90aa7-19bb-42ea-a8c9-456bbe765a5c"},{"name":"/Purchasing","item":[{"name":"/POReceiver","item":[{"name":"{POST}","id":"5c677de9-c487-493a-b48a-da29cedf694f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"This allows you to send and receive data as JSON.
\n","type":"text"},{"key":"X-API-Key","value":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ASNNumber\": 0,\r\n \"AutoPost\": false,\r\n \"Complete\": false,\r\n \"ExpireDate\": \"2022-05-30\",\r\n \"ImportTransactionID\": 0,\r\n \"Location\": \"NEWINV\",\r\n \"MaterialID\": \"MATERIALID\",\r\n \"MatlLotNbr\": \"\",\r\n \"NbrLabels\": 0,\r\n \"POItem\": 1,\r\n \"PONumber\": 1,\r\n \"PrintLabels\": false,\r\n \"Receiver\": 0,\r\n \"RecvBy\": \"USER\",\r\n \"RecvDate\": \"2022-05-30\",\r\n \"RecvQty\": 1,\r\n \"ScaleTicketNumber\": 0,\r\n \"ShipVia\": \"UPS\",\r\n \"SupplierLotNbr\": \"\",\r\n \"SupplierPS\": \"1234845\",\r\n \"UnitPrice\": 20.0,\r\n \"VouchRefNum\": 1\r\n}"},"url":"https://api.blinfo.com/company/Purchasing/POReceiver","description":"Allows for creating a receiver against a Purchase Order.
\nAdded in 6.4.1.
\nASNNumber - Type integer :
Supplier ASN Number used with this receipt.
AutoPost - Type boolean :
Determines if this transaction will be automatically posted or not.
Complete - Type boolean :
Indicates if this item will be received as complete or not.
ExpireDate - Type string :
Date the material expires in UTC (YYYY-MM-DD) format.
ImportTransactionID - Type integer :
Unique identifier for imported transactions. If specified, must be unique.
Location - Type string :
Inventory location being received into.
MaterialID - Type string :
Material being received.
MatlLotNbr - Type string :
This is the material lot number. It will be blank if this material is not tracked by lot number.
NbrLabels - Type integer :
This is the number of labels to print for this receipt. If left at 0 it will default to 1.
POItem - Type integer :
Purchase Order Item being received.
PONumber - Type integer :
Unique identifier for the Purchase Order being receiverd against.
PrintLabels - Type boolean :
Designates wether a label is required for this material/lot/location of this receipt.
Receiver - Type integer :
Unique identifier for receiving of this material.
RecvBy - Type string :
The user or name of person receiving the material.
RecvDate - Type string :
Date the material is received in UTC (YYYY-MM-DD) format.
RecvQty - Type decimal :
Quantity of material received.
ScaleTicketNumber - Type integer :
Information-only field for identifying the scale ticket for imported POReceivers.
ShipVia - Type string :
Method of shipment for the item being received.
SupplierLotNbr - Type string :
This is the supplier lot number for the material.
SupplierPS - Type string :
Supplier's packing slip number for the material.
UnitPrice - Type decimal :
Unit price at time of receipt.
VoucherRefNum - Type integer :
Defines the voucher reference number for the A/P invoice that was auto created with this receiver.
This allows you to send and receive data as JSON.
\n","type":"text"},{"key":"X-API-Key","value":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Account\": \"\",\r\n \"AffectBook\": false,\r\n \"AutoPost\": false,\r\n \"Confirm\": false,\r\n \"Confirmation\": \"\",\r\n \"CostType\": \"\",\r\n \"CurrCode\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"Equipment\": \"\",\r\n \"ErrorFlag\": false,\r\n \"ErrorText\": \"\",\r\n \"FOB\": \"\",\r\n \"GroupCode\": \"\",\r\n \"JobNumber\": \"\",\r\n \"MFGCode\": \"\",\r\n \"MaterialID\": \"MATLID\",\r\n \"MatlDesc1\": \"\",\r\n \"MatlDesc2\": \"\",\r\n \"NoCharge\": false,\r\n \"OrderItem\": 0,\r\n \"OrderNumber\": 0,\r\n \"OrderQty\": 0,\r\n \"OrderType\": \"\",\r\n \"PODate\": \"2022-08-21\",\r\n \"POItem\": 0,\r\n \"PONumber\": 0,\r\n \"PayMethod\": \"\",\r\n \"PromiseDate\": \"\",\r\n \"PurchAgent\": \"\",\r\n \"RelNum\": 0,\r\n \"RequestDate\": \"2022-08-21\",\r\n \"Requester\": \"\",\r\n \"Revision\": \"\",\r\n \"SendEmail\": false,\r\n \"ShipVia\": \"\",\r\n \"SupplierID\": \"\",\r\n \"SupplierLoc\": \"\",\r\n \"Taxable\": false,\r\n \"TermCode\": \"\",\r\n \"Tool\": \"\",\r\n \"ToolCostType\": \"\",\r\n \"UnitMeas\": \"\",\r\n \"UnitPrice\": 0 \r\n}"},"url":"https://api.blinfo.com/company/Purchasing/POTransaction","description":"Allows for importing into the Purchase Order Transactions (POTransactions) table to easily create purchase orders from a source outside of Odyssey.
\nAdded in 6.4.2.
\nAccount - Type string :
Account number to be charged for this item.
AffectBook - Type boolean :
If selected, this purchase order item will affect bookings.
AutoPost - Type boolean :
Automatically post transaction when imported.
Confirm - Type boolean :
Select if purchase order is confirming.
Confirmation - Type string :
Confirmation number for this purchase order.
CostType - Type string :
User defined cost type for accumulating equipment costs.
CurrCode - Type string :
Unique identifier for the currency.
EmailAddress - Type string :
Address that the PO Item receipt notification is automatically emailed to when it is received.
Equipment - Type string :
Equipment associated with this purchase order.
ErrorFlag - Type boolean :
Record is in error and ccannot be posted until fixed.
ErrorText - Type string :
Details of the error that caused the record to be flagged as in error.
FOB - Type string :
Freight on board.
GroupCode - Type string :
User-defined code used for grouping purposes to classify purchase order items into groups.
JobNumber - Type string :
Job cost number this item is being charged against.
MFGCode - Type string :
Original manufacturer.
MaterialID - Type string :
Material inventory ID for this item.
MatlDesc1 - Type string :
Text describing the material for this item.
MatlDesc2- Type string :
Additional text describing the material for this item.
NoCharge - Type boolean :
Flag indicating whether the supplier will be charging us for this item.
OrderItem - Type integer :
Order item that this material is being purchased for.
OrderNumber - Type integer :
Order number that this material is being specifically purchased for.
OrderQty - Type decimal :
Total on order for this item
OrderType - Type string :
Identifies the type of order (customer order (C), shop order (S), work order (W), tool order (T), etc).
PODate - Type string :
Date of purchase order in UTC (YYYY-MM-DD) fiormat.
POItem - Type integer :
Unique identifier for this item withing the purchase order.
PONumber - Type integer :
Unique identifier for this purchase order.
PayMethod - Type string :
Method of payment for this purchase order.
PromiseDate - Type string :
The supplier's ship date in UTC (YYYY-MM-DD) fiormat.
PurchAgent - Type string :
Person assigned to this supplier or purchase order.
RelNum - Type integer :
Unique release date number.
RequestDate - Type string :
The date this quantity is desired in UTC (YYYY-MM-DD) fiormat.
Requester - Type string :
Who requested ordering this item.
Revision - Type string :
Revision level for this item.
SendEmail - Type boolean :
Allows sending an e-mail notifier when this PO Item is received against.
ShipVia - Type string :
Method of shipment.
SupplierID - Type string :
Unique supplier identification.
SupplierLoc - Type string :
Location code for the supplier if multiple locations exist.
Taxable - Type boolean :
Select if this item is taxable.
TermCode - Type string :
Unique identifier for the payment term.
Tool - Type string :
Tool number this item is being charged against.
ToolCostType - Type string :
User-defined cost type for accumulating tooling costs.
UnitMeas - Type string :
Unit of measure as purchased.
UnitPrice - Type decimal :
Purchase price per unit for this item.
Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"This allows you to send and receive data as JSON.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CompanyID\": \"ODSY\",\n \"TableName\": \"Employees\",\n \"ListOfFieldValues\": [\n {\n \"Key\": \"ClockNumber\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Name\",\n \"Value\": \"Allison Smith\"\n },\n {\n \"Key\": \"Shift\",\n \"Value\": \"1\"\n },\n {\n \"Key\": \"Foreman\",\n \"Value\": \"DOUG\"\n },\n {\n \"Key\": \"Department\",\n \"Value\": \"1\"\n },\n {\n \"Key\":\"Badge\",\n \"Value\":\"456456\"\n }\n ]\n}"},"url":"https://api.blinfo.com/company/Record/Add","description":"This method is used to add a single record into the database. This method returns an AddRecordResponse, which contains the UniqueID of the added record. This UniqueID can then be used elsewhere for updating or deleting.
TableName - Type String :\nThis input parameter identifies the name of the table in the database that contains the record you wish to delete.
\nListOfFieldValues - Type List of String[key] and String[value] pairs :\nThis is an array of key-value-pairs. The key is the field name, and the value is the value you wish to set for that field.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["Record","Add"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"101efc2b-3cd7-4814-bfee-82bab390c8c3"},{"name":"/Delete","id":"7f6365c0-5f45-41af-92ee-b361aad19e1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TableName\": \"Employees\",\n \"UniqueID\": 123456,\n \"CompanyID\": \"ODSY\"\n}"},"url":"https://api.blinfo.com/company/Record/Delete","description":"The Delete method is used to remove a single record from the database.
The return object property, ErrorMessage, will inform you of any error that might have occurred when attempting the deletion.
TableName - Type String :\nThis input parameter identifies the name of the table in the database that contains the record you wish to delete.
\nUniqueID - Type Integer :\nThis input parameter specifies the Unique ID of the record that you wish to delete.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["Record","Delete"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f6365c0-5f45-41af-92ee-b361aad19e1f"},{"name":"/Find","id":"3e0f3996-85da-4682-a073-4ab14b05ab54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CompanyID\": \"ODSY\",\n \"TableName\": \"Employees\",\n \"ListOfFieldValues\": [\n {\n \"Key\": \"ClockNumber\",\n \"Value\": \"10500\"\n }\n ]\n}"},"url":"https://api.blinfo.com/company/Record/Find","description":"This method will allow you to find a single record in the database using one or more fields and their values.
\nTableName - Type String :\nThis identifies the name of the Data View to run. It must exist in the same company that you logged into.
\nListOfFieldValues - Type List of String[key] and String[value] pairs :\nThis is an array of key-value-pairs. The key is the field name, and the value is the value you wish to set for that field.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["Record","Find"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e0f3996-85da-4682-a073-4ab14b05ab54"},{"name":"/Import","id":"c3f91f79-20f3-46a4-96e4-7f3a57396932","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ProfileID\": \"OOD-ImportTest\",\r\n \"SourceFileData\": \"ClockNumber,Name,Shift,Foreman,Department,Badge\\r\\n10551,Allison Smith-T1,1,DOUG,1,10551\\r\\n10552,Allison Smith-T2,1,DOUG,1,10552\\r\\n10553,Allison Smith-T3,1,DOUG,1,10553\\r\\n10554,Allison Smith-T4,1,DOUG,1,10554\\r\\n10555,Allison Smith-T5,1,DOUG,1,10555\",\r\n \"CompanyID\":\"ODSY\"\r\n}"},"url":"https://api.blinfo.com/company/Record/Import","description":"This method is used to import records into the database.
\nProfileID - Type String : \nThe Import Profile ID that you are running.
\nSourceFileData - Type String : \nThe content of the file you are importing from.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["Record","Import"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3f91f79-20f3-46a4-96e4-7f3a57396932"},{"name":"/Update","id":"a3fd0905-a964-4ed1-a771-28affd6a8463","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"TableName\": \"Employees\",\r\n \"UniqueID\": 9504,\r\n \"ListOfFieldValues\": [\r\n {\r\n \"Key\": \"Name\",\r\n \"Value\": \"Allison Smith (Modified)\"\r\n },\r\n {\r\n \"Key\": \"Address1\",\r\n \"Value\": \"1234 Main Street\"\r\n }\r\n ],\r\n \"CompanyID\": \"ODSY\"\r\n}"},"url":"https://api.blinfo.com/company/Record/Update","description":"The Update method is used to update a single record in the database with new values.
The return object property, ErrorMessage, will inform you of any error that might have occurred when attempting the deletion.
TableName - Type String :\nThis input parameter identifies the name of the Odyssey table that you will be updating the record in.
\nUniqueID - Type Integer :\nThis is the unique ID of the record that you will be updating.
\nListOfFieldValues - Type List of String[key] and String[value] pairs :\nThis is an array of key-value-pairs. The key is the field name, and the value is the value you wish to set for that field.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["Record","Update"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3fd0905-a964-4ed1-a771-28affd6a8463"}],"id":"2dd328ca-ecc3-46ee-bfdb-060514ef1dfc","description":"The Record Controller provides record updating, adding, finding, and deleting capabilities.
\n","_postman_id":"2dd328ca-ecc3-46ee-bfdb-060514ef1dfc"},{"name":"/Spectrometer","item":[{"name":"{POST}","id":"41f1a8f1-55d2-4a7a-ae1a-484fd11aa6ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"This allows you to send and receive data as JSON.
\n","type":"text"},{"key":"X-API-Key","value":"Your API Key, from Odyssey.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Heat\": \"Heat1\",\r\n \"Elements\": {\r\n \"O\": 10.0,\r\n \"FE\": 90.0\r\n },\r\n \"CompanyID\": \"ODSY\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.blinfo.com/company/Spectrometer","description":"Creates a new chemical reading for a specified heat.
\n","urlObject":{"path":["Spectrometer"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"41f1a8f1-55d2-4a7a-ae1a-484fd11aa6ef"}],"id":"33788a9a-3b17-448f-9819-988b282bc82b","_postman_id":"33788a9a-3b17-448f-9819-988b282bc82b","description":""},{"name":"/Supplier","item":[{"name":"{GET}","id":"f5c3072d-6975-488f-8245-14564609fcff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Returns up to 1,000 matching, Active Suppliers from the MainDB.Supplier table.
\nIf a search text value is provided, records will be returned where the ID, or POName match the given value (using a wild-card matches search).
\nSearchText - Type string :\nThis value, if supplied, will be used to filter your results. This value will be searched using a MATCHES operator on the ID OR POName fields in the Supplier table.
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\n","urlObject":{"path":["Supplier"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"},{"key":"SearchText","value":""}],"variable":[]}},"response":[],"_postman_id":"f5c3072d-6975-488f-8245-14564609fcff"},{"name":"/{UniqueID}","id":"61d2909a-d029-4891-b0bd-c25d33a5b27c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Fetch a specific supplier from the Odyssey database from the MainDB.Supplier table.
\nThese parameters are automatically passed to the API call because they're included as part of the URL to access the API endpoint
\nUniqueID - Type integer :\nThe UniqueID of the supplier you are searching for. This supplier can exist in any company you have access to.
\nCompanyID - Type string :\nThe optional CompanyID that will be used to authenticate your request. This value is required if you're using a non-company-specific API Key.
\n","urlObject":{"path":["Supplier","1381"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"61d2909a-d029-4891-b0bd-c25d33a5b27c"},{"name":"/{UniqueID}/PlantFields","id":"d234e7e9-fed6-4c80-9ff8-ba8d2cec2982","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Returns a list of plant-level fields that a controlling company can change for a specific Supplier and their current values.
\nThese parameters are automatically passed to the API call because they're included as part of the URL to access the API endpoint
\nUniqueID - Type integer :\nThe UniqueID of the supplier you are fetching fields for. This supplier should exist within the HQ company.
\nCompanyID - Type string :\nThe optional CompanyID. If you're using a company-specific APIKey, this value is not required. The CompanyID associated with your APIKey will be used to fetch the plant-level fields. If you're using a non-company-specific APIKey, then this value is required.
\n","urlObject":{"path":["Supplier","1381","PlantFields"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"d234e7e9-fed6-4c80-9ff8-ba8d2cec2982"},{"name":"/{UniqueID}/PlantFields","id":"c19a7545-dcf2-4b14-b7fb-08661096c017","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"X-API-Key","type":"text","value":"Allows for updating plant-level fields from a Headquaters company for a selected Supplier.
\nThese parameters are automatically passed to the API call because they're included as part of the URL to access the API endpoint
\nUniqueID - Type integer :\nThe UniqueID of the Supplier you are fetching fields for. This supplier should exist within the HQ company.
\nCompanyID - Type string :\nThe optional CompanyID. If you're using a company-specific APIKey, this value is not required. The CompanyID associated with your APIKey will be used to fetch the plant-level fields. If you're using a non-company-specific APIKey, then this value is required.
\nPlantList - Type string array :\nThis is a list of the CompanyID's of the plants to be updated.
\nFields - Type *PlantFieldUpdateModel array :\nThis is an array of all the fields that are being returned containing information the front-end will use to build the screen
\nFieldValue - Type string :\nThe new value of the field you wish to apply to all the plants in the PlantList
\nField - Type PlantFieldModel :\nThe entire field object that you are updating.
\nFieldName - Type string :\nThe name of the field
\nFieldLabel - Type string :\nThe label of the field
\nDataType - Type string :\nThe data type of the field. Integer, String, Boolean, etc
\nFormat - Type string :\nThe display format of the field. The possible values are: - Boolean Values - yes/no - This format represents a value that is either true or false. These values are typically represented as checkboxes. - Character Values - X(number) - This format means that you can input a character string of \"number\" length. For example, X(10) means that you can enter a string of up to 10 characters, and only the first 10 characters of the value will be displayed. - Integer Or Decimal Values - >>>,>>>, -99,999, >>>>, etc - This format represents how long the field is and where any commas may be present. It also indicates if if the field supports negative (-) numbers or not. - Date Values - MM/DD/YY, DD/MM/YYYY, MM/DD/YYYY HH:MM:SS, etc - This format indicates how the date and associated time, if any, will be displayed.
\nFieldValue - Type string :\nThe current value of this field
\nOptions - Type string :\nThe list of possible options for this field, if this field's DataType is 'List'.
\nPlantValues - Type Dictionary<string, string> :\nA list of all plants in this organization, and the value for this field in that plant, if it exists.
\n","urlObject":{"path":["Supplier","1381","PlantFields"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"c19a7545-dcf2-4b14-b7fb-08661096c017"}],"id":"38a8a3ca-cd4f-4105-a315-58afae58cb95","_postman_id":"38a8a3ca-cd4f-4105-a315-58afae58cb95","description":""},{"name":"/System","item":[{"name":"/GetModuleAccess","id":"5e5b7bb6-d9dd-41b7-814d-ce8b5930fa57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CompanyID\": \"ODSY\",\n \"Module\": \"SC\"\n}"},"url":"https://api.blinfo.com/company/System/GetModuleAccess","description":"This method will allow you to determine whether your organization has access to a given module.
\nModule - Type String :\nThe two-character module code.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["System","GetModuleAccess"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e5b7bb6-d9dd-41b7-814d-ce8b5930fa57"},{"name":"/PrintQueueAdmin/Complete","id":"3ebe7f4e-1403-4ddc-8d12-c9fabf60c421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"JobID\": 1234,\n \"CompanyID\":\"ODSY\"\n}"},"url":"https://api.blinfo.com/company/System/PrintQueueAdmin/Complete","description":"This method marks the given print job as complete.
\nJobID - Type Integer : \nThe print job ID to complete.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["System","PrintQueueAdmin","Complete"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ebe7f4e-1403-4ddc-8d12-c9fabf60c421"},{"name":"/PrintQueueAdmin/StartJob","id":"377edab9-173a-431f-b182-da1269baedbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"JobID\": 1234,\n \"CompanyID\":\"ODSY\"\n}"},"url":"https://api.blinfo.com/company/System/PrintQueueAdmin/StartJob","description":"This endpoint attempts to start the given print job.
\nJobID - Type Integer : \nThe print job ID to start.
\nCompanyID - Type String : \nThis is the Company that you are logging into. Your user that you are logging into Odyssey with must have access to this company. You can fetch records from any company, based your query.
\n","urlObject":{"path":["System","PrintQueueAdmin","StartJob"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"377edab9-173a-431f-b182-da1269baedbe"},{"name":"/ServerTime","id":"f94622cb-afbf-47c9-b8ed-6a0789b7949e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/System/ServerTime?CompanyID=ODSY","description":"This endpoint returns UTC date and time of the server in ISO format
\nCompanyID - Type String : \nThis optional parameter defines the CompanyID to use for APIKey validation, if using a global APIKey. If your APIKey was generated for a specific company, you do not have to supply this parameter.
\n","urlObject":{"path":["System","ServerTime"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"f94622cb-afbf-47c9-b8ed-6a0789b7949e"},{"name":"/ErrorMessage/{ErrorID}","id":"97296e81-aaba-47b2-b84f-7291ab0fed11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/System/ErrorMessage/0020?CompanyID=ODSY","description":"ErrorID - Type String : \nThe ID of the error message you wish to get information about
\nCompanyID - Type String : \nThis optional parameter defines the CompanyID to use for APIKey validation, if using a global APIKey. If your APIKey was generated for a specific company, you do not have to supply this parameter.
\n","urlObject":{"path":["System","ErrorMessage","0020"],"host":["https://api.blinfo.com/company"],"query":[{"key":"CompanyID","value":"ODSY"}],"variable":[]}},"response":[],"_postman_id":"97296e81-aaba-47b2-b84f-7291ab0fed11"},{"name":"/Version","id":"29c4ac63-884d-4ea0-a08f-f18d9a754fcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.blinfo.com/company/System/Version","description":"This endpoint returns version information about the API.
\nThis endpoint does not require an APIKey or any validation.
\nNo parameter are required to use this endpoint.
\n","urlObject":{"path":["System","Version"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"29c4ac63-884d-4ea0-a08f-f18d9a754fcb"},{"name":"/ValidateUsername","id":"77f656cd-4366-4a66-a840-f8f95d9738f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Your API Key, from Odyssey. Put your key in the variables section, not here.
\n","key":"X-API-Key","type":"text","value":"This allows you to send and receive data as JSON.
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Username\": \"userId\",\r\n \"Password\": \"password\"\r\n}"},"url":"https://api.blinfo.com/company/System/ValidateUsername","description":"This method checks a user ID and password, to see if it is valid.
\nUsername - Type String :\nThe username of the user whose credentials you are validating.
\nPassword - Type String : \nThe password of the user whose credentials you are validating.
\n","urlObject":{"path":["System","ValidateUsername"],"host":["https://api.blinfo.com/company"],"query":[],"variable":[]}},"response":[],"_postman_id":"77f656cd-4366-4a66-a840-f8f95d9738f8"}],"id":"f328a04e-8f2d-4db2-831b-77540492a52f","description":"The SystemController exposes various system functions within Odyssey
\n","_postman_id":"f328a04e-8f2d-4db2-831b-77540492a52f"}],"event":[{"listen":"prerequest","script":{"id":"7f3587b0-cd6e-4737-87fc-d0dc8e2fba7a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fe3b2a2b-3f3a-42c3-9875-a68a0ea4a00c","type":"text/javascript","exec":[""]}}],"variable":[{"key":"APIKey","value":"