{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"af662455-1c12-4f11-aed2-6fa00cd01993","name":"RFMS Data Service API","description":"Access CCA RFMS data within your own application using a standard REST API.\n\nPlease note that divisions will be filtered based on the authorization client used to call this API.\n\nSwagger page: [https://ase-rfmsdata-prod.azurewebsites.net/swagger/index.html](https://ase-rfmsdata-prod.azurewebsites.net/swagger/index.html)\n\n# Standard Responses\n\n<u><b>Paginated Response</b></u>\n\nAll endpoints ending in '/filter' support pagination.\n\nPage size for pagination can be controlled via the 'limit' parameter. The default value for 'limit' is 50 with a max of 10000.\n\nEndpoints supporting pagination always return a structure like this:\n\n```\n{\n    \"data\": [\n        {},\n        {}\n    ],\n    \"meta\": {\n        \"next\": {\n            \"offset\": 50    //Offset value of next page. Can be controlled via 'offset' parameter\n        },\n        \"prev\": null,    //Offset value of previous page. Can be controlled via 'offset' parameter\n        \"currentCount\": 50,    //# of records on page. Page size can be increased via 'limit' parameter\n        \"totalCount\": 400    //Total # of records matching filter criteria\n    },\n        \"links\": {\n        \"next\": \"https://exampleapi.com/Location?offset=50\",    //URL for next page of filtered API call.\n        \"self\": \"https://exampleapi.com/Location\",    //URL for current page of filtered API call.\n        \"prev\": null    //URL for previous page of filtered API call.\n    }\n}\n\n ```\n\n<u><b>Unpaginated Response</b></u>\n\nEndpoints not supporting pagination (Ex: /Order/OrderLookup) return an object directly that may contain nested objects. Please see the object definition by endpoint for further info.\n\n```\n{\n    \"exampleField\": \"exampleValue\",\n    \"nestedObjects\": [\n        {},\n        {}\n    ]\n}\n\n ```\n\n# Using Filter Endpoints\n\n## <u><b>Filter Get</b></u>\n\nGet requests on /filter endpoints support an optional operator for any supplied parameters. Parameters can also use the standard '=' operator.\n\n## Operator Mapping\n\n---\n\n| **Operator Name** | **Call Syntax** |\n| --- | --- |\n| Equal | \\=eq:\\[FieldValue\\] |\n| NotEqual | \\=ne:\\[FieldValue\\] |\n| GreaterThan | \\=gt:\\[FieldValue\\] |\n| GreaterThanOrEqual | \\=ge:\\[FieldValue\\] |\n| LessThan | \\=lt:\\[FieldValue\\] |\n| LessThanOrEqual | \\=le:\\[FieldValue\\] |\n| Like | \\=like:\\[FieldValue\\] |\n| IsNull | \\=isnull:\\[FieldValue\\] |\n\nEx: /api/Endpoint/filter?limit=10&where\\[CcaDivision\\]=DivisionName&where\\[LastModifiedDateTime\\]=gt:01/01/2025 00:00&order=-InvNum\n\n## <u><b>Filter Post</b></u>\n\n### \\*Functionality only available for ProSource divisions!\n\nPost requests on /filter endpoints offer the same functionality as Get filter requests, but have a different syntax.\n\nExample body:\n\n```\n{\n  \"fields\": [\n    \"Field1\" //An array of field names. If provided, only the specified fields names will be populated in the response.\n  ],\n  \"filters\": [\n    {\n      \"name\": \"Field1\",\n      \"operator\": \"Equal\",\n      \"value\": \"Value1\"  //Can provide a single value or an array of values.\n    }\n  ],\n  \"order\": [\n    {\n      \"name\": \"Field1\", //If provided, will sort by the specified field.\n      \"sortDescending\": true\n    }\n  ],\n  \"offset\": 0, //Pagination controls\n  \"limit\": 0\n}\n\n ```\n\n## Operator values\n\n- Equal\n    \n- NotEqual\n    \n- GreaterThan\n    \n- GreaterThanOrEqual\n    \n- LessThan\n    \n- LessThanOrEqual\n    \n- Between\n    \n- Like\n    \n- IsNull","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"46753385","team":8858747,"collectionId":"af662455-1c12-4f11-aed2-6fa00cd01993","publishedId":"2sB3dQwAEV","public":true,"publicUrl":"https://documentation.rfmsdata.ccaglobal.com","privateUrl":"https://go.postman.co/documentation/46753385-af662455-1c12-4f11-aed2-6fa00cd01993","customColor":{"top-bar":"4989AF","right-sidebar":"003457","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/b54f2a92-c3ce-40af-b5f0-815f70679e0d/Q0NBX1ZlcnRpY2FsXzIwMThfcmV2MS1ub3RhZy5wbmc=","colors":{"top-bar":"003457","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/b54f2a92-c3ce-40af-b5f0-815f70679e0d/Q0NBX1ZlcnRpY2FsXzIwMThfcmV2MS1ub3RhZy5wbmc=","colors":{"top-bar":"4989AF","right-sidebar":"003457","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-12-09T21:28:16.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/b54f2a92-c3ce-40af-b5f0-815f70679e0d/Q0NBX1ZlcnRpY2FsXzIwMThfcmV2MS1ub3RhZy5wbmc=","logoDark":"https://content.pstmn.io/b54f2a92-c3ce-40af-b5f0-815f70679e0d/Q0NBX1ZlcnRpY2FsXzIwMThfcmV2MS1ub3RhZy5wbmc="}},"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/eb072ad654b6b6cb2f9362be7cb8046b61728531b48a3311de63a687bb4cf6b2","favicon":"https://ccaglobal.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://documentation.rfmsdata.ccaglobal.com/view/metadata/2sB3dQwAEV"}