{"id":360,"date":"2020-04-29T17:19:41","date_gmt":"2020-04-29T17:19:41","guid":{"rendered":"https:\/\/senitron.net\/developers\/?page_id=360"},"modified":"2020-05-01T17:55:27","modified_gmt":"2020-05-01T17:55:27","slug":"restapi-categories-list","status":"publish","type":"page","link":"https:\/\/senitron.net\/developers\/restapi-categories-list\/","title":{"rendered":"RESTAPI-Categories List"},"content":{"rendered":"
<\/div>
<\/div><\/div>
<\/div>

Service Name<\/span> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Categories List<\/span>
\nService Method<\/span> \u00a0 \u00a0\u00a0 GET<\/span>
\nService URL<\/span> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/epcs\/categories?location=001&page=1&per_page=10&query=xxx<\/span><\/span><\/p>\n

Query Parameters<\/span>
\nlocation<\/span> = <location code<\/span>>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 (Required)<\/span>
\npage <\/span> = <start page for list pagination<\/span>>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 (Optional)<\/span>
\nper_page <\/span> = <count of records in every page<\/span>> \u00a0 \u00a0 \u00a0 (Optional)<\/span>
\nquery <\/span>= <category name or a part of that<\/span>>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0 (Optional)<\/span><\/p>\n

Note:
\nThe API always returns two default categories in first of categories list (\"All Categories\" and \"Un Assigned\").<\/p>\n

Request Header Fields<\/span>
\nContent-Type<\/span> = application\/json<\/span>
\nAuthorization<\/span> = <token><\/span><\/p>\n

Response Data (JSON)<\/span>
\n{
\n\"pagination<\/span>\": {<\/span>
\n\"current_page<\/span>\": <page number<\/span>>,
\n\"per_page<\/span>\": <page size<\/span>>,
\n\"total_entries<\/span>\": <total records><\/span><\/span>
\n},<\/span>
\n\"categories<\/span>\": [<\/span>
\n{<\/span>
\n\"id<\/span>\": -1<\/span>,
\n\"name<\/span>\": \"All Categories<\/span>\"<\/span>
\n},
\n{<\/span>
\n\"id<\/span>\": -2<\/span>,
\n\"name<\/span>\": \"Un Assigned\"<\/span><\/span>
\n},
\n{<\/span>
\n\"id<\/span>\": <category id<\/span>>,
\n\"name<\/span>\": \"<category name<\/span>>\"<\/span>
\n},
\n...<\/span>
\n]<\/span>
\n}<\/p>\n

 <\/p>\n

Example <\/span>
\nGET: http:\/\/app.senitron.net\/api\/v1\/epcs\/categories?location=001&per_page=3&query=4b<\/span>
\n{
\n\"pagination<\/span>\": {<\/span>
\n\"current_page<\/span>\": 1<\/span>,
\n\"per_page<\/span>\": 10<\/span>,
\n\"total_entries<\/span>\": 5<\/span><\/span>
\n},
\n\"categories<\/span>\": [<\/span>
\n{<\/span>
\n\"id<\/span>\": -1<\/span>,
\n\"name<\/span>\": \"All Categories<\/span>\"<\/span>
\n},
\n{<\/span>
\n\"id<\/span>\": -2<\/span>,
\n\"name<\/span>\": \"Un Assigned<\/span>\"<\/span>
\n},
\n{<\/span>
\n\"id<\/span>\": 381307<\/span>,
\n\"name<\/span>\": \"4bu<\/span>\"<\/span>
\n},
\n{<\/span>
\n\"id<\/span>\": 381316<\/span>,
\n\"name<\/span>\": \"4bp<\/span>\"<\/span>
\n},
\n{<\/span>
\n\"id<\/span>\": 381358<\/span>,
\n\"name<\/span>\": \"4bw<\/span>\"<\/span>
\n},
\n{<\/span>
\n\"id<\/span>\": 381362<\/span>,
\n\"name<\/span>\": \"4bt<\/span>\"<\/span>
\n},
\n{<\/span>
\n\"id<\/span>\": 381365<\/span>,
\n\"name<\/span>\": \"4bc<\/span>\"<\/span>
\n}<\/span>
\n]<\/span>
\n}<\/p>\n<\/div>

<\/div><\/div><\/div><\/div><\/div>\n","protected":false},"excerpt":{"rendered":"","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"side-navigation.php","meta":{"footnotes":""},"class_list":["post-360","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/senitron.net\/developers\/wp-json\/wp\/v2\/pages\/360","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/senitron.net\/developers\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/senitron.net\/developers\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/senitron.net\/developers\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/senitron.net\/developers\/wp-json\/wp\/v2\/comments?post=360"}],"version-history":[{"count":1,"href":"https:\/\/senitron.net\/developers\/wp-json\/wp\/v2\/pages\/360\/revisions"}],"predecessor-version":[{"id":1925,"href":"https:\/\/senitron.net\/developers\/wp-json\/wp\/v2\/pages\/360\/revisions\/1925"}],"wp:attachment":[{"href":"https:\/\/senitron.net\/developers\/wp-json\/wp\/v2\/media?parent=360"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}