{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Class API – URL Structure, Requests, and Responses","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"class-api--url-structure-requests-and-responses","__idx":0},"children":["Class API – URL Structure, Requests, and Responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page outlines the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL structure"]}," and the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["request/response formats"]}," used by the Class API."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"url-structure","__idx":1},"children":["URL Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints follow this pattern:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api.class.com.au/api/{version}/{scope}/{area}/{action}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Components"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"URL Component"},"children":["URL Component"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The API version. Currently the only valid value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1.0"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scope"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The scope of the requested resource:",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business level"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["b/{BusinessCode}"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fund level"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["f/{BusinessCode}/{FundCode}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["area"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Logical grouping of endpoints by resource (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fund-data"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["member-data"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["action"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The specific resource and action (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["member-detail/{memberId}"]},")."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.class.com.au/api/1.0/b/Business/fund-data/fund-list"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.class.com.au/api/1.0/f/Business/Fund/member-data/member-detail/35572c36-9d63-4be5-a86f-072040a2781e"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-headers","__idx":2},"children":["Request Headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Class API uses standard HTTP headers to control behavior."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies response media type ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["and"]}," action version.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Supported media types: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/xml"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Action version format: `application/vnd.superip.action.v{version}+{json"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Media type of the request body.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Supported: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/xml"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/x-www-form-urlencoded; charset=UTF-8"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Default if omitted"]},": interpreted as XML."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send the access token as a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://tools.ietf.org/html/rfc6750"},"children":["Bearer token"]},". ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Case-sensitive"]},", including the word ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Bearer Orh1Vz8T..."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tip:"]}," When in doubt, prefer ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept: application/vnd.superip.action.v1+json"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type: application/json"]}," for JSON workflows."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-format","__idx":3},"children":["Response Format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All responses share a common envelope:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"Errors\": [\n    {\n      \"Code\": \"ErrorCode\",\n      \"Message\": \"A detailed, human-readable message explaining the error\"\n    }\n  ],\n  \"Data\": { }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unsuccessful requests"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Errors"]},": contains one or more error objects with a code and message."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Data"]},": empty object."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Successful requests"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Errors"]},": empty array."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Data"]},": contains the endpoint-specific payload (see each endpoint’s documentation)."]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-code-overview","__idx":4},"children":["Response Code Overview"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status Code"},"children":["Status Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OK"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request completed successfully."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad Request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request could not be processed. See response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Errors"]}," for details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthorized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing/invalid credentials, insufficient permissions, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["expired token"]},", or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["token scope"]}," does not satisfy required scope."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Resource not found (e.g., Business or Fund does not exist; token target scope does not match the business; valid business/fund but incorrect API name)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["406"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not Acceptable"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}," header did not include any supported media types."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["415"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unsupported Media Type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," header specified an unsupported media type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal Server Error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An unhandled error occurred. Please report to Class."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["501"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not Implemented"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unsupported API version or action version."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["503"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unavailable"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service is down for maintenance or temporarily unavailable."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"minimal-curl-example-bearer--json","__idx":5},"children":["Minimal cURL Example (Bearer + JSON)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api.class.com.au/api/1.0/b/Business/fund-data/fund-list' \\\n  --header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n  --header 'Accept: application/vnd.superip.action.v1+json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{},"children":[]}]},"headings":[{"value":"Class API – URL Structure, Requests, and Responses","id":"class-api--url-structure-requests-and-responses","depth":1},{"value":"URL Structure","id":"url-structure","depth":2},{"value":"Request Headers","id":"request-headers","depth":2},{"value":"Response Format","id":"response-format","depth":2},{"value":"Response Code Overview","id":"response-code-overview","depth":2},{"value":"Minimal cURL Example (Bearer + JSON)","id":"minimal-curl-example-bearer--json","depth":2}],"frontmatter":{"seo":{"title":"Class API – URL Structure, Requests, and Responses"}},"lastModified":"2025-11-13T12:04:05.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/nowinfinity/resources/class-api-structure","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}