Versions Compared

Version Old Version 1 New Version Current
Changes made by

Peter Humphries (Deactivated)

Peter Humphries (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Endpoints

...

Endpoint

 

...

  • REST (GET/POST): /services/rest/user/creditBalance?username=[]&password=[]
  • SOAP: /services/ws/user?wsdl (method: creditBalance)

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://server.submission.mc5.smspl.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:creditBalance>
         <username>?</username>
         <password>?</password>

   </soapenv:Body>
</soapenv:Envelope>

 

What information to return?

For the REST endpoint (JSON)

 

{

...

If query is ok:

Code Block
{
    "creditBalance": "100",
    "errorCode

    "status": "
-200
0",

}

 

...

If query invalid:

 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:creditBalanceResponse xmlns:ns1="http://server.submission.mc5.smspl.com/">
         <return>            
            <creditBalance>100</creditBalance>
            <errorCode>-200</errorCode>         
         </return>
      </ns1:creditBalanceResponse>
   </soap:Body>
</soap:Envelope>

 

...

Code Block
{
 "status": <errorStatusCode>,
}

E.g.  for invalid login/password it will return status: 3 meaning "Authentication failed"