Admin Web Service

Admin

Click here for a complete list of operations.

GetUserGeneralPropertiesByPrimary

Returns the properties of the user UserID who is a member of the supplied primary user's account

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Admin.asmx HTTP/1.1
Host: ws.interfax.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://interfax.net/Admin/GetUserGeneralPropertiesByPrimary"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetUserGeneralPropertiesByPrimary xmlns="http://interfax.net/Admin">
      <UserID>string</UserID>
      <PrimaryUserID>string</PrimaryUserID>
      <PrimaryUserPassword>string</PrimaryUserPassword>
    </GetUserGeneralPropertiesByPrimary>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetUserGeneralPropertiesByPrimaryResponse xmlns="http://interfax.net/Admin">
      <GetUserGeneralPropertiesByPrimaryResult>
        <UserID>string</UserID>
        <AccountID>unsignedInt</AccountID>
        <AccountType>string</AccountType>
        <IsPrimary>boolean</IsPrimary>
        <IsWorldPay>boolean</IsWorldPay>
        <IsClosed>boolean</IsClosed>
        <IsTx>boolean</IsTx>
        <IsRx>boolean</IsRx>
        <TZName>string</TZName>
        <CountryID>string</CountryID>
        <IsLite>boolean</IsLite>
        <IsSuspended>boolean</IsSuspended>
        <Options>string</Options>
      </GetUserGeneralPropertiesByPrimaryResult>
    </GetUserGeneralPropertiesByPrimaryResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Admin.asmx HTTP/1.1
Host: ws.interfax.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetUserGeneralPropertiesByPrimary xmlns="http://interfax.net/Admin">
      <UserID>string</UserID>
      <PrimaryUserID>string</PrimaryUserID>
      <PrimaryUserPassword>string</PrimaryUserPassword>
    </GetUserGeneralPropertiesByPrimary>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetUserGeneralPropertiesByPrimaryResponse xmlns="http://interfax.net/Admin">
      <GetUserGeneralPropertiesByPrimaryResult>
        <UserID>string</UserID>
        <AccountID>unsignedInt</AccountID>
        <AccountType>string</AccountType>
        <IsPrimary>boolean</IsPrimary>
        <IsWorldPay>boolean</IsWorldPay>
        <IsClosed>boolean</IsClosed>
        <IsTx>boolean</IsTx>
        <IsRx>boolean</IsRx>
        <TZName>string</TZName>
        <CountryID>string</CountryID>
        <IsLite>boolean</IsLite>
        <IsSuspended>boolean</IsSuspended>
        <Options>string</Options>
      </GetUserGeneralPropertiesByPrimaryResult>
    </GetUserGeneralPropertiesByPrimaryResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Admin.asmx/GetUserGeneralPropertiesByPrimary?UserID=string&PrimaryUserID=string&PrimaryUserPassword=string HTTP/1.1
Host: ws.interfax.net

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<UserGeneralProps xmlns="http://interfax.net/Admin">
  <UserID>string</UserID>
  <AccountID>unsignedInt</AccountID>
  <AccountType>string</AccountType>
  <IsPrimary>boolean</IsPrimary>
  <IsWorldPay>boolean</IsWorldPay>
  <IsClosed>boolean</IsClosed>
  <IsTx>boolean</IsTx>
  <IsRx>boolean</IsRx>
  <TZName>string</TZName>
  <CountryID>string</CountryID>
  <IsLite>boolean</IsLite>
  <IsSuspended>boolean</IsSuspended>
  <Options>string</Options>
</UserGeneralProps>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Admin.asmx/GetUserGeneralPropertiesByPrimary HTTP/1.1
Host: ws.interfax.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

UserID=string&PrimaryUserID=string&PrimaryUserPassword=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<UserGeneralProps xmlns="http://interfax.net/Admin">
  <UserID>string</UserID>
  <AccountID>unsignedInt</AccountID>
  <AccountType>string</AccountType>
  <IsPrimary>boolean</IsPrimary>
  <IsWorldPay>boolean</IsWorldPay>
  <IsClosed>boolean</IsClosed>
  <IsTx>boolean</IsTx>
  <IsRx>boolean</IsRx>
  <TZName>string</TZName>
  <CountryID>string</CountryID>
  <IsLite>boolean</IsLite>
  <IsSuspended>boolean</IsSuspended>
  <Options>string</Options>
</UserGeneralProps>

Parameter	Value
UserID:
PrimaryUserID:
PrimaryUserPassword: