Full Upload ‘data’ Node
Full Activity Upload and Full Inventory Upload 'data' node have similar structures, and will therefore be described together. For 'head/upload_type' = 'full' and 'head/processing_mode'='appointments_only' - Full Activity Upload 'data' Node. For 'head/upload_type' = 'full' and 'head/processing_mode'='inventory_only' – Full activity Upload 'data' Node.
Both 'data' nodes contain a single child 'providers', which is an array of resources for which the data will be uploaded, as follows:
<data>
<providers>
<provider></provider>
<provider></provider>
<provider></provider>
</providers
</data>
'provider' structure
The 'provider’ structure consists of the following elements:
| Name | Required | Type | Description |
|---|---|---|---|
external_id |
Yes |
string key |
resource's 'external_id' indicates the resource for which the action will be performed |
fallback_external_id |
No |
string key |
used if the resource specified by 'external_id' field is not available for some reason (e.g. on holiday etc.) default value: none |
appointments |
- |
struct |
mandatory for Full Activity Upload array of 'appointment' structures for activities that are to be uploaded for this resource |
inventories |
- |
struct |
mandatory for Full Inventory Upload array of 'inventory' structures for inventory that is to be uploaded for this resource |
userdata |
No |
string |
string returned in SOAP response without change Not used by the Inbound Interface, but is intended for use by clients (for example a client may use this to store an ID in SOAP request and then quickly find record in SOAP response using such ID). default value: none |
| Full Activity Upload Data Example | Full Inventory Upload Data Example |
|---|---|
|
|
Incremental Upload Request Example
<Envelope>
<Body>
<inbound_interface_request>
<user>
<now>2007-06-08T14:46:08+02:00</now>
<company>bhn10</company>
<login>root</login>
<auth_string>f33b5c67b17060091c2a588663b9e99e</auth_string>
</user>
<head>
<upload_type>incremental</upload_type>
<id>test_incremental_fileupload.xml</id>
<date>2007-06-08</date>
<allow_change_date>yes</allow_change_date>
<appointment>
<keys>
<field>appt_number</field>
<field>customer_number</field>
</keys>
</appointment>
<inventory>
<keys>
<field>invsn</field>
</keys>
</inventory>
<provider_group>bhn10_resource_group</provider_group>
</head>
<data>
<commands>
<command>
<date>2007-06-08</date>
<type>update_appointment</type>
<external_id>53305</external_id>
<appointment>
<appt_number>0001</appt_number>
<customer_number>Customer_number N85</customer_number>
<worktype>11</worktype>
<service_window_start>8:00</service_window_start>
<service_window_end>19:00</service_window_end>
<name>name</name>
<phone>11111111</phone>
<email>test@test.com</email>
<cell>11111111</cell>
<address>address</address>
<city>city</city>
<zip>11111</zip>
<state>CA</state>
<language>1</language>
<daybefore_flag>0</daybefore_flag>
<reminder_time>0</reminder_time>
<time_zone>2</time_zone>
<properties>
<property>
<label>MAP_GRID</label>
<value>AA11</value>
</property>
</properties>
</appointment>
</command>
</commands>
</data>
</inbound_interface_request>
</Body>
</Envelope>Full Activity Upload Request Example
<Envelope>
<Body>
<inbound_interface_request>
<user>
<now>2007-06-08T14:46:08+02:00</now>
<company>bhn10</company>
<login>root</login>
<auth_string>f33b5c67b17060091c2a588663b9e99e</auth_string>
</user>
<head>
<upload_type>full</upload_type>
<id>full_fileupload.xml</id>
<date>2007-05-25</date
<appointment>
<keys>
<field>appt_number</field>
<field>customer_number</field>
</keys>
</appointment>
<inventory>
<keys>
<field>invsn</field>
</keys>
</inventory>
<provider_group>group</provider_group>
<processing_mode>inventory_only</processing_mode>
</head>
<data>
<providers>
<provider>
<external_id>53302</external_id>
<appointments>
<appointment>
<appt_number>0001</appt_number>
<customer_number>Customer_number N85</customer_number>
<worktype>11</worktype>
<service_window_start>8:00</service_window_start>
<service_window_end>19:00</service_window_end>
<name>name</name>
<phone>11111111</phone>
<email>test@test.com</email>
<cell>11111111</cell>
<address>address</address>
<city>city</city>
<zip>11111</zip>
<state>CA</state>
<language>1</language>
<daybefore_flag>0</daybefore_flag>
<reminder_time>0</reminder_time>
<time_zone>2</time_zone>
<property>
<properties>
<label>MAP_GRID</label>
<value>AA11</value>
</property>
</properties>
</appointment>
< /appointments>
</provider>
</providers>
</data>
</inbound_interface_request>
</Body>
</Envelope>Full Inventory Upload Request Example
<Envelope>
<Body>
<inbound_interface_request>
<user>
<now>2007-06-08T14:46:08+02:00</now>
<company>bhn10</company>
<login>root</login>
<auth_string>f33b5c67b17060091c2a588663b9e99e</auth_string>
</user>
<head>
<upload_type>full</upload_type>
<id>full_fileupload.xml</id>
<date>2007-05-25</date
<appointment>
<keys>
<field>appt_number</field>
<field>customer_number</field>
</keys>
</appointment>
<inventory>
<keys>
<field>invsn</field>
</keys>
</inventory>
<provider_group>group</provider_group>
<processing_mode>inventory_only</processing_mode>
</head>
<data>
<providers>
<provider>
<external_id>53302</external_id>
<inventories>
<inventory>
<properties>
<property>
<label>ITEM_NUMBER</label>
<value>11111</value>
</property>
<property>
<label>invsn</label>
<value>LALALA-23</value>
</property>
</properties>
</inventory>
< /inventories>
</provider>
</providers>
</data>
</inbound_interface_request>
</Body>
</Envelope>