{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7700117d-c2bd-4a08-befb-702ba29fee99","name":"Integration through REST API","description":"> **REST** (REpresentational State Transfer) - is a very lightweight architectural style supporting communication over HTTP (HTTPS) with minimal overheads. It is as simple as a POST/GET HTTP call.\n\nAlthough similar to our [SOAP integration](https://soap-api-doc.daxtra.com#intro) our REST services can provide XML request and response communication, we anticipate that JSON-based communication will be used most of the time.\n\n---\n\n###### Our REST API call consists of three parts\n\n| DaXtra Server URL | API Version | API Call |\n| --- | --- | --- |\n| Example: {{DAXTRA_SERVER_IP}} | /cvx/rest/api/v1 | API calls from the list below |\n\n###### List of REST API calls\n\n- [/profile/full/json](#9b871501-501d-42ef-90f8-54e87b6bdaba) (POST)\n- [/profile/full/xml](#03f96451-8dc7-4a17-97fc-03aa27fa8047) (POST)\n- [/profile/personal/json](#4078e590-285d-40b4-bc71-e469cc880d02) (POST) †\n- [/profile/personal/xml](#c1309cbd-63f8-405b-a74f-d7d6155f743f) (POST) †\n- [/profile/batch/json](#31036041-0b67-46dc-ac67-387c1a2c6147) (POST) †\n- [/profile/batch/xml](#97880e8a-8513-45ba-b6d3-d0d3ca651555) (POST) †\n- [/data](#565efa90-f4e0-465c-9f7b-2443e7f172e4) (GET) †\n- [/joborder/json](#0c06692a-1c75-4067-a48e-b0c05e9732d7) (POST)\n- [/joborder/xml](#318b6f1e-f43d-4c5d-8e7b-c0ec847f7614) (POST)\n- [/list/screenout](#9d15995d-f9cf-42d7-9605-ccc8445fc841) (POST) ‡\n- [/list/skills](#0b6e9cee-ee51-4543-9673-0d53082810ec) (POST) ‡\n- [/list/screenout](#cefd53e4-ac65-4597-80f2-be34ff90ee61) (GET) ‡\n- [/list/skills](#d1c7756e-5de3-4776-a518-d8cb7971f178) (GET) ‡\n- [/styler](#45abe9f9-776a-4cb4-8342-a2f3bfe7b9c2) (POST)\n- [/styler/xml](#b0d92151-9d28-4a81-8421-639a32370d79) (POST)\n- [/styler/template](#9320333d-1da6-4e63-b82b-ab84ea1ecd7d) (POST) ‡\n- [/styler/template](#72095fb5-51a4-46f1-977d-b0f7b6828da1) (GET) ‡\n- [/convert2xxx](#ea73ac05-40ac-40bf-aa5a-fa12cb1d9f0a) (POST)\n- [/convert2xxx_q](#ea73ac05-40ac-40bf-aa5a-fa12cb1d9f0a) (POST)\n    \n\n† _Features are not currently supported on DaXtra BULK2 and CVX-3 centrally-hosted, load-balanced parsing rings; please ask_ [_DaXtra support_](mailto:support@daxtra.com) _for details._\n\n‡ _For customers on one of our centrally-hosted, load-balanced parsing rings there are different processes to Install and Retrieve Skills file, Screenout file or Styler template. Integration examples:_ [_Integration using Perl_](https://api-doc.daxtra.com/#a9016229-b268-4a71-bc65-132fbce567ea)_._","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6024079","team":269178,"collectionId":"7700117d-c2bd-4a08-befb-702ba29fee99","publishedId":"S11GT1Cv","public":true,"publicUrl":"https://rest-api-doc.daxtra.com","privateUrl":"https://go.postman.co/documentation/6024079-7700117d-c2bd-4a08-befb-702ba29fee99","customColor":{"top-bar":"DDDDDD","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-03-28T16:22:33.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"CVX","id":"6b6fc615-2330-4033-b431-325381dbac00","owner":"6024079","values":[{"key":"XTR1","value":"xtr1.daxtra.com","enabled":true},{"key":"DAXTRA_SERVER_IP","value":"cvxdemo.daxtra.com","enabled":true},{"key":"ACCOUNT","value":"MY_ACCOUNT","enabled":true},{"key":"YUBIKEY","value":"cccccccvrkukfhkjjefncfcgvfcrgljnefrbjkkhchlt","enabled":true},{"key":"DAXTRA_API_TOKEN","value":"476adcce-c55e-4444-8c8e-99db0c0c2828","enabled":true},{"key":"TEST_ACCOUNT","value":"API_TEST","enabled":true},{"key":"V2_ACCOUNT","value":"v2.daxtra.io - expansions service","enabled":true},{"key":"CVX-2","value":"cvx-az-2.daxtra.com","enabled":true},{"key":"CVX-3","value":"cvx-az-3.daxtra.com","enabled":true},{"key":"CVX-LATEST","value":"cvx-latest.daxtra.com","enabled":true},{"key":"ALANTEST2","value":"ALANTEST2-76368126.us-east-1.elb.amazonaws.com","enabled":true},{"key":"SAMPLE_TOKEN","value":"YGZhXWJfXV9dYF9kaWleRT5BXkRAMkEwZWdhaGVlaGRkaGZkZmVnXUE5MkQ2YQ==","enabled":true},{"key":"SIMPLE_RESUME_64","value":"Sm9obiBTbWl0aApFZGluYnVyZ2gsIEVIMjEgNlFELCBVSwoKMjAxNy0yMDE4LCBEYXh0cmEgTHRkLCBQcm9ncmFtIG1hbmFnZXIKUmVwb25zaWJsZSBmb3IgSVQgcHJvamVjdCBwbGFubmluZy4=","enabled":true},{"key":"Lin_VM","value":"192.168.2.179","enabled":true},{"key":"CVX-SING-1","value":"cvx-sing-1.daxtra.com","enabled":true},{"key":"CVX-DEMO","value":"cvxdemo.daxtra.com","enabled":true},{"key":"CVX-EU-2","value":"cvx-eu-2.daxtra.com","enabled":true},{"key":"CVX-TOK-1","value":"loadbalancer-tok-1.daxtra.com","enabled":true},{"key":"CVX-EU-LATEST","value":"loadbalancer-ireland-latest.daxtra.com","enabled":true},{"key":"CVX-LA-FAST","value":"cvx-la-fast.daxtra.com","enabled":true},{"key":"LA-STATIC-1","value":"loadbalancer-la-static-1.daxtra.com","enabled":true},{"key":"ES-DEMO","value":"es-demo.daxtra.com","enabled":true},{"key":"AQUENT_SERVER","value":"aquent-cvx-test.daxtra.com","enabled":true},{"key":"CVX-AU-1","value":"loadbalancer-au-1.daxtra.com","enabled":true},{"key":"OPENAI_API_KEY","value":"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","enabled":true,"type":"default"},{"key":"A9T9-API","value":"PDMXB4398888A","enabled":true,"type":"secret"},{"key":"R7iz","value":"54.91.66.207","enabled":true,"type":"default"},{"key":"CVX-ARABIC","value":"cvx-arabic-test.daxtra.com","enabled":true}],"published":true}],"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/5d8e571ca37a16bc20595266a210d81ebb1a2868ffadd6645db0917f1ee08f3e","favicon":"https://res.cloudinary.com/postman/image/upload/v1550241452/team/ihlzm4sfmmmuckkanhgw.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"},{"label":"CVX","value":"6024079-6b6fc615-2330-4033-b431-325381dbac00"}],"canonicalUrl":"https://rest-api-doc.daxtra.com/view/metadata/S11GT1Cv"}