Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Additional information in the README!

  • Loading branch information...
commit fb20a83829f6992845f36af23a9c35fd7d81ad6d 1 parent 110f23e
@yesdevnull authored
Showing with 90 additions and 1 deletion.
  1. +90 −1 README.md
View
91 README.md
@@ -1,12 +1,101 @@
# GSX Web Services API
-A PHP Class by Dan "theblahman" Barrett
+A PHP Class by Dan "_theblahman_" Barrett
This class is intended for AASPs only
Web: http://theblahman.net
Email: gsx@theblahman.net
+Content Outputs:
+* PHP
+* JSON
+
## REQUIRES
+
* PHP 5.3 and greater
* SOAP module for PHP
* JSON module for PHP
+
+## FUTURE PLANS
+
+I hope to provide much nicer output than what is currently present.
+
+Current:
+```php
+array(1) {
+ ["PartsLookupResponse"]=>
+ array(3) {
+ ["operationId"]=>
+ string(23) "miscOpId"
+ ["parts"]=>
+ array(9) {
+ ["partDescription"]=>
+ string(3) "Fan"
+ ["eeeCode"]=>
+ string(0) ""
+ ["exchangePrice"]=>
+ string(1) "0"
+ ["laborTier"]=>
+ string(4) "LAB1"
+ ["partNumber"]=>
+ string(8) "922-9643"
+ ["partType"]=>
+ string(11) "Replacement"
+ ["stockPrice"]=>
+ string(4) "20.8"
+ ["componentCode"]=>
+ string(1) "1"
+ ["isSerialized"]=>
+ string(1) "N"
+ }
+ ["communicationMessage"]=>
+ string(0) ""
+ }
+}
+```
+
+I'd ideally like to provide cleaner output along with HTTP style codes; in fact, codes will copy current HTTP/1.1 codes.
+
+Planned:
+```php
+array(1){
+ ["ResponseArray"]=>
+ array(4) {
+ ["type"]=>
+ string(6) "output"
+ ["code"]=>
+ string(3) "200"
+ ["responseData"]=>
+ array(9) {
+ ["partDescription"]=>
+ string(3) "Fan"
+ ["eeeCode"]=>
+ string(0) ""
+ ["exchangePrice"]=>
+ string(1) "0"
+ ["laborTier"]=>
+ string(4) "LAB1"
+ ["partNumber"]=>
+ string(8) "922-9643"
+ ["partType"]=>
+ string(11) "Replacement"
+ ["stockPrice"]=>
+ string(4) "20.8"
+ ["componentCode"]=>
+ string(1) "1"
+ ["isSerialized"]=>
+ string(1) "N"
+ }
+ ["urgentMessage"]=>
+ string(0) ""
+ }
+}
+```
+
+Coming soon:
+* Clean display of content along with appropriate return codes
+* .plist output so you don't have to
+* _hopefully_ clean error output
+
+Sometime in the future…
+* REST-ish module
Please sign in to comment.
Something went wrong with that request. Please try again.