{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"27f6ce83-2d44-4a4a-a936-13a42bf47c65","name":"Frontline Asset Management API","description":"Getting Started\n\nREST API\n\nfor Frontline Asset Management\n\nREST API provides you with programmatic access to your data in Frontline Asset Management (formerly TIPWeb-IT). The flexibility and scalability of REST API make it an excellent choice for integrating with your other applications and for performing complex operations on a large scale. However, understanding and using REST API requires basic familiarity with software development, web services, and the Frontline Asset Management user interface.\n\nYou can use any tool or development environment that can make REST requests. If you have many records to process, consider using this API which is based on REST principles and optimized for large sets of data.\n\nAccess API documentation here: [https://apidocs.tipwebhss.com/](https://apidocs.tipwebhss.com/)\n\nRead, write, update or delete operations performed using the API on the customers instance are executed on the live, production database and in real-time. Any changes made to the instance and its database will take effect immediately and are irreversible.\n\nCommon Uses of the API\n\nYou can set up and use REST API in many ways including the following most used capabilities:\n\nView Assets Issued to Students/Staff\n\nFields accessible from the API response:\n\n- Tag Number\n- Serial Number\n- Site Name\n- Student/Staff Name\n- Asset Status\n- Product Name\n- Product Type\n- Manufacturer\n- Model\n- Suggested Price\n- Due Date\n- Date Issued\n- Accessories (Name, Description, Price)\n    \n\nUpdate the Status of an Existing Tag Issued to a Room (not Student/Staff)\n\nRoom Status updates available from the API:\n\n- Auctioned\n- Available\n- Disposed\n- In Repair\n- In Use\n- Lost\n- Recycled\n- Returned To Vendor\n- Sold\n- Stolen\n- Surplus\n- Used For Parts\n    \n\nSet Up Authentication\n\nYour API URL, Secret Key and Passphrase needed for API authentication can be found by accessing Frontline Asset Management.\n\nLogin in with Admin Admin credentials to the district view of Frontline Asset Management (formerly TIPWeb-IT)\n\nFrom the Left Navigation menu under the Management sub header, click District Settings.\n\nWhen the Manage District Settings modal window appears, navigate to the API and SSO Information section\n\nPlease note your API URL, Secret Key and Passphrase needed for API authentication.\n\nTo successfully send requests, REST API requires an access token obtained by authentication.\n\nUsers of the REST API can authenticate by providing a key and phrase (secret) to the REST API login resource with the HTTP POST method. A JWT bearer token is generated that enables the user to authenticate future requests.\n\nThe bearer token remains active for a period of 8 hours from the time that it is issued (the time that the AuthorizeAPI call is made successfully). After it expires, APIs that rely on the token will not work until after the AuthorizeAPI call is made successfully once again, thereby getting a new bearer token.\n\nWalk Through the Sample Code: Get the Version\n\nTo retrieve information about the Frontline Asset Management version, submit a Home Request. You can copy and paste this example to send them with cURL. But first replace TIPWebAPI_URL in the base URI with your application domain.\n\nA public \"test\" API allows users to test whether the API is active or not. In this case, the request doesn’t require authentication.\n\ncurl --location -g '{{TIPWebAPI_Url}}/api/Home' \\\\\n\n\\--header 'Content-Type: application/json'\n\nThe output from this request returns a JSON that includes the version number of the API.\n\nIf the API has not been activated for the application URL, please contact Frontline customer support.\n\nEndFragment","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"15084744","team":1684269,"collectionId":"27f6ce83-2d44-4a4a-a936-13a42bf47c65","publishedId":"U16dQoQF","public":true,"publicUrl":"https://apidocs.tipwebhss.com","privateUrl":"https://go.postman.co/documentation/15084744-27f6ce83-2d44-4a4a-a936-13a42bf47c65","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.5","publishDate":"2021-08-31T21:05:01.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/0f6e475d22d2a8b30a0302771b535d6b269055972421a661ab254fd40f0d94df","favicon":"https://tipwebhss.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidocs.tipwebhss.com/view/metadata/U16dQoQF"}