Read Properties

{ "name" "read properties", "method" "post", "url" "https //wsb bakuun com/ratedockapi/rdkx/readproperties", "description" "retrieve the status of all properties mapped under a partner account in bakuun ", "tab" "examples", "examples" { "languages" \[ { "id" " a6ev31cslizcdtyzhisl", "language" "json", "code" "{\n \\"username\\" \\"testusername\\",\n \\"password\\" \\"testpassword\\",\n \\"partnerid\\" \\"rdkxxx\\",\n \\"action\\" \\"readproperties\\"\n}", "customlabel" "" }, { "id" "j6azivcgjnpkoe0lxyjd2", "language" "curl", "code" "curl location 'https //wsb bakuun com/ratedockapi/rdkx/readproperties' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\n \\"username\\" \\"string\\",\n \\"password\\" \\"string\\",\n \\"partnerid\\" \\"string\\",\n \\"action\\" \\"string\\"\n}'", "customlabel" "" }, { "id" "hsfpdpizdcldyxsv26my ", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //wsb bakuun com/ratedockapi/rdkx/readproperties',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"username\\" \\"string\\",\n \\"password\\" \\"string\\",\n \\"partnerid\\" \\"string\\",\n \\"action\\" \\"string\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "chzwn4 s5vahb3cqwtyy2", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"username\\" \\"string\\",\n \\"password\\" \\"string\\",\n \\"partnerid\\" \\"string\\",\n \\"action\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //wsb bakuun com/ratedockapi/rdkx/readproperties\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "cjudqvcfaq70ij0kcselx", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //wsb bakuun com/ratedockapi/rdkx/readproperties\\"\n\npayload = json dumps({\n \\"username\\" \\"string\\",\n \\"password\\" \\"string\\",\n \\"partnerid\\" \\"string\\",\n \\"action\\" \\"string\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "yc ocqd wfhu28rtsdzh2", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //wsb bakuun com/ratedockapi/rdkx/readproperties\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"username\\" \\"string\\",\n \\"password\\" \\"string\\",\n \\"partnerid\\" \\"string\\",\n \\"action\\" \\"string\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" " a6ev31cslizcdtyzhisl" }, "results" { "languages" \[ { "id" "bvujfridcm7llpyvvpe0n", "language" "200", "code" "{\n \\"status\\" true,\n \\"propertydata\\" \[\n {\n \\"propertycode\\" \\"htlxx x\\",\n \\"propertyname\\" \\"property test\\",\n \\"mappingstatus\\" \\"completed\\"\n },\n {\n \\"propertycode\\" \\"htlxx x\\",\n \\"propertyname\\" \\"property test 1\\",\n \\"mappingstatus\\" \\"to start\\"\n },\n {\n \\"propertycode\\" \\"htlxx x\\",\n \\"propertyname\\" \\"property test 2\\",\n \\"mappingstatus\\" \\"disconnected\\"\n }\n ]\n}", "customlabel" "" }, { "id" "4trsqtziivrtdf0gtbjxr", "language" "401", "code" "{\n \\"success\\" false,\n \\"errors\\" \[\n {\n \\"code\\" 410,\n \\"message\\" \\"unauthorised user\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" "bvujfridcm7llpyvvpe0n" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "username", "kind" "required", "type" "string", "description" "system generated, human readable api access key (unique per account) ", "" "system generated, human readable api access key (unique per account) " }, { "name" "password", "kind" "required", "type" "string", "description" "system generated, human readable api access key (unique per account) ", "" "system generated, human readable api access key (unique per account) " }, { "name" "partnerid", "kind" "required", "type" "string", "description" "partner (buyer) identifier (e g rdkxx mpbxxx) ", "" "partner (buyer) identifier (e g rdkxx mpbxxx) " }, { "name" "action", "kind" "required", "type" "string", "description" "defines the requested operation must be set to readproperties ", "" "defines the requested operation must be set to readproperties " } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "status", "kind" "optional", "type" "boolean", "description" "" }, { "name" "propertydata", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "propertycode", "kind" "optional", "type" "string", "description" "unique bakuun property identifier (e g htlxx 3)" }, { "name" "propertyname", "kind" "optional", "type" "string", "description" "display name of the property " }, { "name" "mappingstatus", "kind" "optional", "type" "string", "description" "current mapping status of the property in bakuun available status are \n draft\n to start\n completed\n disconnected\n suspended" } ] } ] }