{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9f4e0d6f-4d4c-4349-8f7a-bdefebb904a0","name":"Fuzion v2 API Docs (Published)","description":"Public documentation of Freeman's \"Fuzion\" v2 REST API.\n\n## Authentication\n\nThe Fuzion v2 API uses the OAuth 2.0 standard based on [RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749) for authentication. Refer to the [Accesstokens](#8b24293d-1b43-4606-8185-1f7173840dfa) folder documentation for additional details.\n\n---\n\n## Requests\n\nUnder a few entities, such as `registrations` and `registrationorders`, `sessions`, `subsessions`, `speakers`, `posters,` it is possible to write multiple related children`entities` with a single `JSON POST and PATCH` request.\n\n### Query Parameters\n\n#### Filters\n\n`?filter[field][operator]=value`\n\nGeneral filter functionality for all the _List_ endpoints of the Fuzion V2 API.\n\n| **Data Types** | **Allowed Operators** |\n| --- | --- |\n| arrays | in |\n| arrayFields | contains |\n| booleans | eq |\n| numbers | eq, lt, lte, gt, gte, ne |\n| strings | endsWith, eq, like, ne, startsWith, substring |\n| uuids | eq |\n\n#### Include\n\n`?include=entity1,entity2`\n\nThe READ endpoints of the Fuzion V2 API support including related entities by providing them as a comma-separated list string.\n\n### Validation\n\n#### Field Validations\n\nBelow is a sample of a validation error where a required field is not provided when creating an entity.\n\n``` json\n{\n    \"name\": \"ValidationError\",\n    \"message\": \"\\\"shortName\\\" is required\",\n    \"requestMethod\": \"POST\",\n    \"requestProperty\": \"body\",\n    \"statusCode\": 422\n}\n\n ```\n\n#### Existence Validation\n\nBelow is a sample of a validation error where the associated parent id field does not exist when creating a child entity.\n\n``` json\n{\n    \"name\": \"ValidationError\",\n    \"message\": \"sessionId (d763347b-056d-472a-a1a6-520b6f57d06f) does not exist.\",\n    \"requestMethod\": \"POST\",\n    \"statusCode\": 422\n}\n\n ```\n\n#### Unique Constraint Validation\n\nBelow is a sample of a validation error when the unique field value already exists.\n\n``` json\n{\n    \"name\": \"ValidationError\",\n    \"message\": \"(fullName)=(Freeman Digital Solutions) already exists.\",\n    \"requestMethod\": \"POST\",\n    \"statusCode\": 422,\n    \"type\": \"unique violation\"\n}\n\n ```\n\n#### Include Entity Validation\n\nBelow is a sample of a validation error when an unrelated or misspelled entity is included in the read endpoints.\n\n``` json\n{\n    \"name\": \"ValidationError\",\n    \"message\": \"Invalid entity provided in the include.\",\n    \"requestMethod\": \"GET\",\n    \"requestProperty\": \"query\",\n    \"statusCode\": 422\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3368789","team":4980926,"collectionId":"9f4e0d6f-4d4c-4349-8f7a-bdefebb904a0","publishedId":"T17CCpoA","public":true,"publicUrl":"https://docs.fuzion.freeman.com","privateUrl":"https://go.postman.co/documentation/3368789-9f4e0d6f-4d4c-4349-8f7a-bdefebb904a0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-03-28T18:13:54.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Documentation","id":"d198cd23-a695-4274-97be-3f0eb11e7ae5","owner":"3368789","values":[{"key":"protocol","value":"https","enabled":true,"type":"default"},{"key":"domain","value":"api.fuzion.freeman.com","enabled":true,"type":"default"},{"key":"port","value":"","enabled":true,"type":"default"},{"key":"OAuthAccessTokenUrl","value":"https://freeman-prod.us.auth0.com/oauth/token","enabled":true,"type":"default"},{"key":"OAuthClientId","value":"<OAuthClientId goes here>","enabled":true,"type":"default"},{"key":"OAuthClientSecret","value":"<OAuthClientSecret goes here>","enabled":true,"type":"default"},{"key":"OAuthAudience","value":"https://api.fuzion.freeman.com","enabled":true,"type":"default"}],"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/5a8756803265272937dd3b8cc8f3a7a1af84a598b661153d88361477660916ff","favicon":"https://freeman.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"},{"label":"Documentation","value":"3368789-d198cd23-a695-4274-97be-3f0eb11e7ae5"}],"canonicalUrl":"https://docs.fuzion.freeman.com/view/metadata/T17CCpoA"}