Exigo Web Services API v3.4.252

GetUserPermissions

Returns permissions associated with the corporate user account.

Input Properties

GetUserPermissionsRequest
PropertyData TypeNotes
LoginNameStringOptional.

Output Properties

GetUserPermissionsResponse
PropertyData TypeNotes
RestrictToCustomerTypesInt32[]List of any Customer Type Restrictions.
RestrictToCustomerStatusesInt32[]List of any Customer Status Restrictions.
RestrictToWarehousesInt32[]List of any warehouse Restrictions.
RestrictToCountriesString[]List of any Country Restrictions.
RestrictToCurrenciesString[]List of any Currency Code Restrictions.
ViewDeletedCustomersBoolean
AllowRemoteCheckPrintBoolean
AllowOverrideItemPriceBoolean
AllowStatementPrintBoolean
DefaultWarehouseID Int32Unique location for orders.
LanguageID Int32Customize the web experience by setting this.
CultureCodeString

SOAP Request

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

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/GetUserPermissions"

<?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:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <GetUserPermissionsRequest xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> </GetUserPermissionsRequest> </soap:Body> </soap:Envelope>

SOAP Response

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> <GetUserPermissionsResult xmlns="http://api.exigo.com/"> <RestrictToCustomerTypes> <int>int</int> </RestrictToCustomerTypes> <RestrictToCustomerStatuses> <int>int</int> </RestrictToCustomerStatuses> <RestrictToWarehouses> <int>int</int> </RestrictToWarehouses> <RestrictToCountries> <string>string</string> </RestrictToCountries> <RestrictToCurrencies> <string>string</string> </RestrictToCurrencies> <ViewDeletedCustomers>boolean</ViewDeletedCustomers> <AllowRemoteCheckPrint>boolean</AllowRemoteCheckPrint> <AllowOverrideItemPrice>boolean</AllowOverrideItemPrice> <AllowStatementPrint>boolean</AllowStatementPrint> <DefaultWarehouseID>int</DefaultWarehouseID> <LanguageID>int</LanguageID> <CultureCode>string</CultureCode> </GetUserPermissionsResult> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    GetUserPermissionsRequest req = new GetUserPermissionsRequest();

 

    req.LoginName = "1";

 

    //Send Request to Server and Get Response

    GetUserPermissionsResponse res = api.GetUserPermissions(req);

 

    //Now examine the results:

    Console.WriteLine("ViewDeletedCustomers: {0}", res.ViewDeletedCustomers);

    Console.WriteLine("AllowRemoteCheckPrint: {0}", res.AllowRemoteCheckPrint);

    Console.WriteLine("AllowOverrideItemPrice: {0}", res.AllowOverrideItemPrice);

    Console.WriteLine("AllowStatementPrint: {0}", res.AllowStatementPrint);

    Console.WriteLine("DefaultWarehouseID: {0}", res.DefaultWarehouseID);

    Console.WriteLine("CultureCode: {0}", res.CultureCode);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new GetUserPermissionsRequest()

 

    req.LoginName = "1"

 

    'Send Request to Server and Get Response

    Dim res As GetUserPermissionsResponse = api.GetUserPermissions(req)

 

    'Now examine the results:

    Console.WriteLine("ViewDeletedCustomers: {0}", res.ViewDeletedCustomers)

    Console.WriteLine("AllowRemoteCheckPrint: {0}", res.AllowRemoteCheckPrint)

    Console.WriteLine("AllowOverrideItemPrice: {0}", res.AllowOverrideItemPrice)

    Console.WriteLine("AllowStatementPrint: {0}", res.AllowStatementPrint)

    Console.WriteLine("DefaultWarehouseID: {0}", res.DefaultWarehouseID)

    Console.WriteLine("CultureCode: {0}", res.CultureCode)

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->LoginName = "1";

 

    //Send Request to Server and Get Response

    $res = $api.GetUserPermissions($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    GetUserPermissionsRequest req = new GetUserPermissionsRequest();

 

    req.setLoginName("1");

 

    //Send Request to Server and Get Response

    GetUserPermissionsResponse res = api.getExigoApiSoap().getUserPermissions(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.