Get Provider List
This method retrieves the accessible Provider List from ResLink's system database, not from the specified client's database. However the SOAP header will still need to be authorised.
Request Profile Table
Element | @Attribute |
Description/Contents |
GetProviderList_RQ |
Root element of message. |
Scenario:
You want to retrieve all of the ProCharter Provider details you can access.
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetProviderList_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
</GetProviderList_RQ>
Response Profile Table
Element | @Attribute |
Description/Contents |
GetProviderList_RS |
Root element of message. |
Providers |
List of Providers |
Provider |
Element for a single Provider Record |
@GUID |
Guid value (max 20 chars) |
@Name |
Display Name |
@ABN |
Provider Australian Business Number (ABN) |
@Currency |
Provider Currency |
Address |
Provider Address |
Contacts |
List of Contacts |
Contact |
Element for a single Provider contact detail |
@Type |
Type of contact. Valid values are [PHONE|FAX|EMAIL|WEBSITE] |
@Description |
Contact description |
@Value |
Contact value |
Example message:
<?xml version="1.0" encoding="utf-16"?>
<GetProviderList_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Providers xmlns="ResLink">
<Provider GUID="TEST" Name="Test Provider" ABN="99 999 999 999" Currency="AUD" >
<Address>1 Some St, Someplace, QLD 4000</Address>
<Contact>
<Contact Type="PHONE" Decription="Phone" Value="0733334444" />
<Contact Type="EMAIL" Decription="Email" Value="bookings@testagent.com" />
<Contact Type="FAX" Decription="Fax" Value="0733334445" />
<Contact Type="PHONE" Decription="Accounts Phone" Value="0733334446" />
<Contact Type="EMAIL" Decription="Accounts Email" Value="accounts@testagent.com" />
<Contact Type="WEBSITE" Decription="Website" Value="testagent.com" />
</Contacts>
</Provider>
</Providers>
<TimeStamp xmlns="ResLink">2014-03-31T13:16:25.5744516+10:00</TimeStamp>
<Errors xmlns="ResLink" />
<Warnings xmlns="ResLink" />
</GetProviderList_RS>