API Documentation

List Clients

Method URI: https://mcssl.com/API/{MerchantId}/Clients/LIST

Example Request 
https://mcssl.com/API/118303/Clients/LIST

POST DATA
<Request>
    <Key>9679623159ec4a51a9...</Key>
    <LimitCount>10</LimitCount>
    <LimitOffset>10</LimitOffset>
    <SortColumn>SomeField</SortColumn>
    <SortOrder>DESC</SortOrder>
</Request>

Element Name	Description	Required	Default
Key	Your Merchant Key	Y
LimitCount	The maximum number of records you would like returned	N	100
LimitOffset	The starting record within the result list	N	0
SortColumn	The field from the record that you want to sort on	N	Id
SortOrder	ASC or DESC	N	DESC

Available SortColumn values: FirstName, LastName

Example Response
<Response success="true" xmlns:xlink="http://www.w3.org/1999/xlink">
    <NextRecordSet>
        <LimitCount>10</LimitCount>
        <LimitOffset>20</LimitOffset>
        <SortColumn>SomeField</SortColumn>
        <SortOrder>DESC</SortOrder>
    </NextRecordSet>
    <Clients>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457882">173457882</Client>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457843">173457843</Client>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457411">173457411</Client>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457260">173457260</Client>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457259">173457259</Client>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457258">173457258</Client>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457256">173457256</Client>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457168">173457168</Client>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457101">173457101</Client>
        <Client xlink:href="https://www.mcssl.com/API/32012/Clients/173457034">173457034</Client>
    </Clients>
</Response>

In this case you should grab the <NextRecordSet> node and include it in a subsequent request to get the next batch of records. When you have reached the end of the result set the <NextRecordSet> will not be returned in the response.

The <Response> root element has a success attribute. This will be true or false. In the case of a false value you will get an Error element in the Response

Error Response
<Response success="false">
    <Error code="2040">No data found</Error>
</Response>