User Tools

Site Tools


delta-service

This is an old revision of the document!


Teamamerica Delta API Documentation

Welcome to the Teamamerica Delta API Interface Guide. We hope you will have a smooth and successful integration to our system.

Should you have any question or need any assistance, Please contact: it@teamamericany.com

Development Rest EndPoint: http://devxml40.volateam.com:8081/TaDeltaApi/TeamAmerica/

Note: only whitelisted IP addresses will be granted access to this endpoint. Please ensure that the relevant IP addresses are whitelisted to avoid any disruption in service.

Requests

✔ GetRateChanges(XML)

Header:

NameValue
Content-Type application/xml
Accept application/xml

Description: XML Request

LevelNameTypeOccursRequiredComments
0 GetDeltaRateChangesRQ string 1 Y
1 UserName string 1 Y
1 Password string 1 Y
1 CityCode string 1 N Use ListCities to get City Codes from all available Cities, It is recommend to use CityCode for faster result
1 HotelID string 1 N In this block you may enter specific vendor ID’s (Hotels), and narrow the search results to only your preferred hotels
1 LastSynced string 1 Y ISO YYYY-MM-DDTH:MM:ssZ(ZonalTime) - data will be retrieved that have changed since the last sync time

XML Request

  <GetDeltaRateChangesRQ>
     <UserName>username</UserName>
     <Password>password</Password>
     <CityCode></CityCode>
     <HotelID>69</HotelID>
     <LastSynced>2025-02-20T12:00:00Z</LastSynced>
  </GetDeltaRateChangesRQ>

XML Response

LevelNameTypeOccursRequiredComments
0 GetDeltaRateChangesRS 1
1 TimeStamp DATE_TIME 1 1
1 Hotels 1 1
2 Hotel 1..N 1 attribute id = hotel code
3 Product 1..N 1 attribute code = product code
4 Created 1 1
5 DateRange 1..N
6 From Date 1 start date
6 To Date 1 end date
4 Updated 1 1
5 Rate 1 1
6 DateRange 1..N
7 From Date 1 start date
7 To Date 1 end date
4 Deleted 1 1
5 DateRange 1..N
6 From Date 1 start date
6 To Date 1 end date
<GetDeltaRateChangesRS>
    <TimeStamp>2025-02-28 06:45:28</TimeStamp>
    <Hotels>
        <Hotel id="69">
            <Product code="NYCHXXXXX">
                <Created>
                    <DateRange>
                       <From>2025-08-01</From>
                       <To>2025-08-11</To>
 		    </DateRange>
 		</Created>    	
                <Updated>
                    <Rate>
                        <DateRange>
                            <From>2025-07-01</From>
                            <To>2025-07-11</To>
                        </DateRange>
                        <DateRange>
                            <From>2025-07-13</From>
                            <To>2025-07-19</To>
                        </DateRange>
                        <DateRange>
                            <From>2025-07-21</From>
                            <To>2025-08-29</To>
                        </DateRange>
                        <DateRange>
                            <From>2025-08-31</From>
                            <To>2025-09-01</To>
                        </DateRange>
                    </Rate>
                </Updated>
                <Deleted>
	            <DateRange>
                       <From>2025-07-01</From>
                       <To>2025-07-11</To>
                    </DateRange>
                </Deleted>                
            </Product>
       
        </Hotel>
    </Hotels>
</GetDeltaRateChangesRS>

✔ RateChanges(JSON)

Header:

NameValue
Content-Type application/json
Accept application/json

Description: JSON Request

{
    "UserName": "username",
    "Password": "*password*,
    "CityCode": "NYC",
    "HotelID": "131",
    "LastSynced": "2025-02-15T12:00:00Z"
  }

JSON Response

{
    "TimeStamp": "2025-02-20 23:08:44",
    "Hotels": {
        "Hotel": [
            {
                "id": "131",

                "Product": [
                    {
                        "code": "NYCGHPRK25",
                        "Created": {
                            "DateRange": [
                                {
                                    "From": "2025-06-11",
                                    "To": "2025-06-12"
                                },
                                {
                                    "From": "2025-06-16",
                                    "To": "2025-06-16"
                                },
                                {
                                    "From": "2025-06-18",
                                    "To": "2025-06-19"
                                }
                                
                            ]
                        },
                        "Updated": {
                            "Rate": {
                                "DateRange": [
                                    {
                                        "From": "2025-06-26",
                                        "To": "2025-06-26"
                                    },
                                    {
                                        "From": "2025-06-30",
                                        "To": "2025-06-30"
                                    },
                                    {
                                        "From": "2025-07-02",
                                        "To": "2025-07-03"
                                    }
                                ]
                            },
                           
                        "Deleted": {
                            "DateRange": [
                                {
                                    "From": "2025-08-22",
                                    "To": "2025-08-24"
                                }
                            ]
                        }
                    }
                   
                ]
            }
        ]
    }
}

✔ InventoryChanges(XML)

Header:

NameValue
Content-Type application/xml
Accept application/xml

Description: XML Request

LevelNameTypeOccursRequiredComments
0 GetDeltaInventoryChangesRQ string 1 Y
1 UserName string 1 Y
1 Password string 1 Y
1 CityCode string 1 N Use ListCities to get City Codes from all available Cities, It is recommend to use cityCode for faster result
1 HotelID string 1 N In this block you may enter specific vendor ID’s (Hotels), and narrow the search results to only your preferred hotels
1 ShowOnRequest int 1 Y can be 0 or 1
1 ShowClosedOut int 1 Y can be 0 or 1
1 LastSynced string 1 Y ISO YYYY-MM-DDTH:MM:ssZ(ZonalTime)
 <GetDeltaInventoryChangesRQ>
     <UserName>username</UserName>
     <Password>******</Password>
     <CityCode>NYC</CityCode>
     <HotelID></HotelID>
     <ShowOnRequest>0</ShowOnRequest>
     <ShowClosedOut>1</ShowClosedOut>
     <LastSynced>2025-02-15T12:00:00Z</LastSynced>
 </GetDeltaInventoryChangesRQ>

XML Response

LevelNameTypeOccursRequiredComments
0 GetDeltaInventoryChangesRS 1
1 TimeStamp DATE_TIME 1 1
1 Hotels 1 1
2 Hotel 1..N 1 attribute id = hotel code
3 Product 1..N 1 attribute code = product code
4 Updated 1 1
5 Inventory 1 1
6 Status 1..N attribute Type=ClosedOut/OnRequest
7 DateRange 1..N
8 From Date 1 start date
8 To Date 1 end date
 <GetDeltaInventoryChangesRS>
    <TimeStamp>2025-02-28 06:45:28</TimeStamp>
    <Hotels>
        <Hotel id="69">
            <Product code="NYCETANY10">
                <Updated>
                    <Inventory>
                        <Status type="OnRequest">
                            <DateRange>
                                <From>2025-03-04</From>
                                <To>2025-03-19</To>
                            </DateRange>
                            <DateRange>
                                <From>2025-03-23</From>
                                <To>2025-03-25</To>
                            </DateRange>
                        </Status>
                        <Status type="ClosedOut">
                            <DateRange>
                                <From>2025-03-20</From>
                                <To>2025-03-22</To>
                            </DateRange>
                            <DateRange>
                                <From>2025-03-29</From>
                                <To>2025-03-29</To>
                            </DateRange>
                            <DateRange>
                                <From>2025-04-03</From>
                                <To>2025-04-04</To>
                            </DateRange>
                        </Status>
                    </Inventory>
                </Updated>
            </Product>
        </Hotel>
    </Hotels>
 </GetDeltaInventoryChangesRS>

✔ InventoryChanges(JSON)

Header:

NameValue
Content-Type application/json
Accept application/json

Description: JSON Request

{
    "UserName": "username",
    "Password": "******",
    "CityCode": "NYC",
    "HotelID": "131",
    "ShowOnRequest" : 1,
    "ShowClosedOut" : 1,
    "LastSynced": "2025-02-15T12:00:00Z"    
  }

JSON Response

{
    "TimeStamp": "2025-02-20 23:08:44",
    "Hotels": {
        "Hotel": [
            {
                "id": "69",

                "Product": [
                    {
                        "code": "NYCXXXX",
                        "Updated": {
                            Updated": {
                            "Inventory": {
                                "Status": [
                                    {
                                        "Type": "OnRequest",
                                        "DateRange": [
                                            {
                                                "From": "2025-12-29",
                                                "To": "2025-12-29"
                                            }
                                        ]
                                    },
                                    {
                                        "Type": "ClosedOut",
                                        "DateRange": [
                                            {
                                                "From": "2025-03-04",
                                                "To": "2025-03-31"
                                            },
                                            {
                                                "From": "2025-05-13",
                                                "To": "2025-05-15"
                                            },
                                            {
                                                "From": "2025-06-02",
                                                "To": "2025-06-04"
                                            },
                                        ]
                                    }
                                ]
                            }
                        }
                    
                    }
                   
                ]
            }
        ]
    }
}

Error Handling

If an error occurs, the API will return an error message in below formats:

XML format:

<ErrorResponse>
  <Code>DCA101</Code>
  <Message>Unauthorized Access: Invalid login credentials</Message>
  <Timestamp>2025-02-19T12:34:56Z</Timestamp>
</ErrorResponse>

JSON format:

{
  "ErrorResponse": {
    "Code": "DCA101",
    "Message": "Unauthorized Access: Invalid login credentials",
    "Timestamp": "2025-02-19T12:34:56Z"
  }
}

Common Error Codes

Code Description
DCA101 Unauthorized Access: Invalid login credentials.
DCA111 Validation Error: One or more fields failed validation checks.
DCA106 Bad Request: The request is malformed or missing required parameters.
DCA104 Data Type Mismatch: Invalid data type detected in the request.

delta-service.1741234247.txt.gz · Last modified: 2025/03/05 23:10 by Administrator