Home > API General > SOAP: Anatomy of Returned XML Document

SOAP: Anatomy of Returned XML Document


Every function call in SOAP will result in a XML document. The document will follow standard XML syntax and namespace conventions, and all requests and responses are data typed. A standard request and response is displayed below.

Request

    <?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>
            <AddDeposit xmlns="http://www.centershift.com/STORE40/">
                <LookupUser_Request>
                    <Username>string</Username>
                    <Password>string</Password>
                    <Channel>int</Channel>
                </LookupUser_Request>
                <Request>
                    <RentalID>long</RentalID>
                    <DepositData>
                        <DEP_GROUP_ID>long</DEP_GROUP_ID>
                        <ORG_ID>long</ORG_ID>
                        <DEP_FIX>decimal</DEP_FIX>
                        <DEP_PERC>decimal</DEP_PERC>
                        <DEP_TYPE>int</DEP_TYPE>
                        <DEP_TYPE_VAL>string</DEP_TYPE_VAL>
                        <ACTIVE>boolean</ACTIVE>
                        <DEP_GROUP_NAME>string</DEP_GROUP_NAME>
                        <DEP_GROUP_DESC>string</DEP_GROUP_DESC>
                        <DEP_METHOD>int</DEP_METHOD>
                        <DEP_METHOD_VAL>string</DEP_METHOD_VAL>
                        <AMT_DESC>string</AMT_DESC>
                        <DEP_AMT>string</DEP_AMT>
                    </DepositData>
                </Request>
            </AddDeposit>
        </soap12:Body>
    </soap12:Envelope>

Response

    <?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>
            <AddDepositResponse xmlns="http://www.centershift.com/STORE40/">
                <AddDepositResult>
                    <Succeeded>boolean</Succeeded>
                </AddDepositResult>
            </AddDepositResponse>
        </soap12:Body>
    </soap12:Envelope>
Categories: API General
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: