{"id":393,"date":"2023-11-23T13:23:19","date_gmt":"2023-11-23T13:23:19","guid":{"rendered":"http:\/\/10.0.1.147\/?page_id=39"},"modified":"2024-07-16T14:24:09","modified_gmt":"2024-07-16T14:24:09","slug":"developers-hc-net-api-response-format","status":"publish","type":"page","link":"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/","title":{"rendered":"Developers HC Net API Response Format"},"content":{"rendered":"<div class=\"col-xs-12 col-sm-8 col-md-8 col-lg-9 float-right\">\n<div class=\"hashcash_developer_sidebar_right\">\n<div class=\"developer_sidebar_right_wrapper \">\n<div class=\"developer-breedcumb anim1 delay-750\">\n<ul>\n<li><a href=\"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-overview\">HC NET APIs<\/a><\/li>\n<li>&gt;<\/li>\n<li>Aurora Rest API<\/li>\n<li>&gt;<\/li>\n<li>Response Format<\/li>\n<\/ul>\n<\/div>\n<div class=\"developer_sidebar_right_inner\">\n<div class=\"developer_sidebar_right_header_wrap\">\n<h2 class=\"developer_sidebar_right_header anim6\"><span class=\"header_left\">Response<\/span> <span class=\"header_right\">Format<\/span><\/h2>\n<\/div>\n<div class=\"developer_sidebar_right_inner_sect anim4\">\n<h3>Response Format<\/h3>\n<p>Rather than using a fully custom way of representing the resources we expose in aurora, we use HAL. HAL is a hypermedia format in JSON that remains simple while giving us a couple of benefits such as simpler client integration for several languages.<\/p>\n<\/div>\n<div class=\"developer_sidebar_right_inner_sect anim4\">\n<h3>Attributes, Links, Embedded Resources<\/h3>\n<p>At its simplest, a HAL response is just a JSON object with a couple of reserved property names:_links is used for expressing links and _embedded is used for bundling other HAL objects with the response. Other than links and embedded objects, <strong>HAL is just JSON<\/strong>.<\/p>\n<h5>Links<\/h5>\n<p>HAL is a hypermedia format, like HTML, in that it has a mechanism to express links between documents. Let\u2019s look at a simple example:<\/p>\n<div class=\"developer_sidebar_right_inner_sect_blackbox\">\n<ul>\n<li>{<\/li>\n<li><span class=\"variab-yellow\">&#8220;_links&#8221;<\/span> : {<\/li>\n<li><span class=\"variab-yellow\">&#8220;self&#8221;<\/span> : {<\/li>\n<li><span class=\"variab-yellow\">&#8220;href&#8221;<\/span> : <span class=\"variab-yellow\">&#8220;\/ledgers\/1&#8221;<\/span><\/li>\n<li>},<\/li>\n<li><span class=\"variab-yellow\">&#8220;transactions&#8221;<\/span> : {<\/li>\n<li><span class=\"variab-yellow\">&#8220;href&#8221;<\/span> : <span class=\"variab-yellow\"> &#8220;\/ledgers\/1\/transactions{?cursor,limit,order}&#8221;<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;templated&#8221;<\/span> : <span class=\"variab-violate\">true<\/span><\/li>\n<li>}<\/li>\n<li>},<\/li>\n<li><span class=\"variab-yellow\">&#8220;id&#8221;<\/span> : <span class=\"variab-yellow\">&#8220;43cf4db3741a7d6c2322e7b646320ce9d7b099a0b3501734dcf70e74a8a4e637&#8221;<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;hash&#8221;<\/span> : <span class=\"variab-yellow\"> &#8220;43cf4db3741a7d6c2322e7b646320ce9d7b099a0b3501734dcf70e74a8a4e637&#8221;<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;prev_hash&#8221;<\/span> : <span class=\"variab-yellow\">&#8220;&#8221;<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;sequence&#8221;<\/span> : <span class=\"variab-violate\">1<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;transaction_count&#8221;<\/span> : <span class=\"variab-violate\">0<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;operation_count&#8221;<\/span> : <span class=\"variab-violate\">0<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;closed_at&#8221;<\/span> : <span class=\"variab-yellow\">&#8220;0001-01-01T00:00:00Z&#8221;<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;total_coins&#8221;<\/span> : <span class=\"variab-yellow\"> &#8220;100000000000.0000000&#8221;<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;fee_pool&#8221;<\/span> : <span class=\"variab-yellow\">&#8220;0.0000000&#8221;<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;base_fee_in_jots&#8221;<\/span> : <span class=\"variab-violate\">100<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;base_reserve_in_jots&#8221;<\/span> : <span class=\"variab-violate\">100000000<\/span>,<\/li>\n<li><span class=\"variab-yellow\">&#8220;max_tx_set_size&#8221;<\/span> : <span class=\"variab-violate\">50<\/span><\/li>\n<li>}<\/li>\n<\/ul>\n<\/div>\n<p>The above response is for the genesis ledger of the HC test network, and the links in the _linksattribute provide links to other relevant resources in aurora. Notice the object beneath the transactions key. The key of each link specifies that links relation to the current resource, and in this case transactions means \u201cTransactions that occurred in this ledger\u201d. Logically, you should expect that resource to respond with a collection of transactions with all of the results having a ledger_sequence attribute equal to 1.<\/p>\n<p>The transactions link is also templated, which means that the href attribute of the link is actually a URI template, as specified by RFC 6570. We use URI templates to show you what parameters a given resource can take. You must evaluate the template to a valid URI before navigating to it.<\/p>\n<\/div>\n<div class=\"developer_sidebar_right_inner_sect anim4\">\n<h3>Pages<\/h3>\n<p>Pages represent a subset of a larger collection of objects.<\/p>\n<p>As an example, it would be unfeasible to provide the All Transactions endpoint without paging.<\/p>\n<p>Over time there will be millions of transactions in the Hashcash network\u2019s ledger and returning them all over a single request would be unfeasible.<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>HC NET APIs &gt; Aurora Rest API &gt; Response Format Response Format Response Format Rather than using a fully custom way of representing the resources we expose in aurora, we use HAL. HAL is a hypermedia format in JSON that remains simple while giving us a couple of benefits such as simpler client integration for [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"template-developers-hc-net-api-response-format.php","meta":{"footnotes":""},"class_list":["post-393","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>HC NET Developers Response Format | HashCash Consultants<\/title>\n<meta name=\"description\" content=\"The response format used in HC NET APIs is superior and has benefits like simpler client integration for many languages.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"HC NET Developers Response Format | HashCash Consultants\" \/>\n<meta property=\"og:description\" content=\"The response format used in HC NET APIs is superior and has benefits like simpler client integration for many languages.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/\" \/>\n<meta property=\"og:site_name\" content=\"Hashcashconsultants\" \/>\n<meta property=\"article:modified_time\" content=\"2024-07-16T14:24:09+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.hashcashconsultants.com\/wp-content\/uploads\/2024\/06\/hashcash-socila-logo.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"200\" \/>\n\t<meta property=\"og:image:height\" content=\"200\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:title\" content=\"HC NET Developers Response Format | HashCash Consultants\" \/>\n<meta name=\"twitter:description\" content=\"The response format used in HC NET APIs is superior and has benefits like simpler client integration for many languages.\" \/>\n<meta name=\"twitter:image\" content=\"https:\/\/www.hashcashconsultants.com\/wp-content\/uploads\/2024\/06\/hashcash-socila-logo.jpg\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/\",\"url\":\"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/\",\"name\":\"HC NET Developers Response Format | HashCash Consultants\",\"isPartOf\":{\"@id\":\"https:\/\/www.hashcashconsultants.com\/#website\"},\"datePublished\":\"2023-11-23T13:23:19+00:00\",\"dateModified\":\"2024-07-16T14:24:09+00:00\",\"description\":\"The response format used in HC NET APIs is superior and has benefits like simpler client integration for many languages.\",\"breadcrumb\":{\"@id\":\"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.hashcashconsultants.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Developers HC Net API Response Format\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.hashcashconsultants.com\/#website\",\"url\":\"https:\/\/www.hashcashconsultants.com\/\",\"name\":\"Hashcashconsultants\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.hashcashconsultants.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"HC NET Developers Response Format | HashCash Consultants","description":"The response format used in HC NET APIs is superior and has benefits like simpler client integration for many languages.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/","og_locale":"en_US","og_type":"article","og_title":"HC NET Developers Response Format | HashCash Consultants","og_description":"The response format used in HC NET APIs is superior and has benefits like simpler client integration for many languages.","og_url":"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/","og_site_name":"Hashcashconsultants","article_modified_time":"2024-07-16T14:24:09+00:00","og_image":[{"width":200,"height":200,"url":"https:\/\/www.hashcashconsultants.com\/wp-content\/uploads\/2024\/06\/hashcash-socila-logo.jpg","type":"image\/jpeg"}],"twitter_card":"summary_large_image","twitter_title":"HC NET Developers Response Format | HashCash Consultants","twitter_description":"The response format used in HC NET APIs is superior and has benefits like simpler client integration for many languages.","twitter_image":"https:\/\/www.hashcashconsultants.com\/wp-content\/uploads\/2024\/06\/hashcash-socila-logo.jpg","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/","url":"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/","name":"HC NET Developers Response Format | HashCash Consultants","isPartOf":{"@id":"https:\/\/www.hashcashconsultants.com\/#website"},"datePublished":"2023-11-23T13:23:19+00:00","dateModified":"2024-07-16T14:24:09+00:00","description":"The response format used in HC NET APIs is superior and has benefits like simpler client integration for many languages.","breadcrumb":{"@id":"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.hashcashconsultants.com\/developers-hc-net-api-response-format\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.hashcashconsultants.com\/"},{"@type":"ListItem","position":2,"name":"Developers HC Net API Response Format"}]},{"@type":"WebSite","@id":"https:\/\/www.hashcashconsultants.com\/#website","url":"https:\/\/www.hashcashconsultants.com\/","name":"Hashcashconsultants","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.hashcashconsultants.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/www.hashcashconsultants.com\/wp-json\/wp\/v2\/pages\/393","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.hashcashconsultants.com\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.hashcashconsultants.com\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.hashcashconsultants.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.hashcashconsultants.com\/wp-json\/wp\/v2\/comments?post=393"}],"version-history":[{"count":4,"href":"https:\/\/www.hashcashconsultants.com\/wp-json\/wp\/v2\/pages\/393\/revisions"}],"predecessor-version":[{"id":1367,"href":"https:\/\/www.hashcashconsultants.com\/wp-json\/wp\/v2\/pages\/393\/revisions\/1367"}],"wp:attachment":[{"href":"https:\/\/www.hashcashconsultants.com\/wp-json\/wp\/v2\/media?parent=393"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}