Find Location operation
The Find Location operation retrieves the details of a location.
The following table describes the elements of the <items>
XML element and the adapter request. If not specified, the valid value for an element should be assumed to be a string.
Elements for the <item> XML element and adapter request for the Find Location operation
Element |
Definition |
Required |
---|---|---|
|
Specifies the name of the operation: |
Yes |
|
Contains the other elements in the request |
Yes |
|
Contains elements that uniquely identify a record |
Yes |
|
Specifies a unique record |
Yes |
|
Specifies the details for the location |
No |
|
Specifies the name of the location |
No |
|
Specifies the address of the location; is an array-type of element |
No |
|
Specifies the city in which the company is located |
No |
|
Specifies the state in which the company is located |
No |
|
Specifies the zip code of the area where the company is located |
No |
|
Specifies the primary contact details for the location |
No |
|
Specifies the phone number for the location |
No |
|
Specifies the opening time for the location |
No |
|
Specifies the closing time for the location |
No |
|
Specifies the primary contact department for the location |
No |
|
Specifies the code for the location |
No |
|
Specifies the comment for the location; is an array-type element |
No |
|
Specifies the country in which the company is located |
No |
|
Specifies the email ID for the location |
No |
|
Specifies the details of the company |
No |
|
Specifies the site category for the location
|
No |
The following figure displays the sample adapter request for the Find Location operation.
Sample adapter request for the Find Location operation
<hp-service-manager-request>
<entity>configurationitem</entity>
<entity-type>location</entity-type>
<request>
<operation-name>retrieve-location</operation-name>
<parameters>
<retrieve-location-request>
<model>
<keys>
<location>
<value>MyLocation25</value>
<type>String</type>
</location>
</keys>
<instance>
<location>
<value>MyLocation25</value>
<type>String</type>
</location>
<location-name>
<value>Location Name</value>
<type>String</type>
</location-name>
<address>
<type>Array</type>
<address>
<element>
<value>Address</value>
<type>String</type>
</element>
</address>
</address>
<city>
<value>City</value>
<type>String</type>
</city>
<state>
<value>State</value>
<type>String</type>
</state>
<zip>
<value>zip</value>
<type>String</type>
</zip>
<primary-contact>
<value>primary contact</value>
<type>String</type>
</primary-contact>
<phone>
<value>Phone</value>
<type>String</type>
</phone>
<location-open-time>
<value>11:00:00</value>
<type>Time</type>
</location-open-time>
<location-closing-time>
<value>12:00:00</value>
<type>Time</type>
</location-closing-time>
<primary-contact-department>
<value>primary contact department</value>
<type>String</type>
</primary-contact-department>
<location-code>
<value>Location Code</value>
<type>String</type>
</location-code>
<comments>
<type>Array</type>
<comments>
<element>
<value>Comment line 1</value>
<type>String</type>
</element>
<element>
<value>Comment line 2</value>
<type>String</type>
</element>
</comments>
</comments>
<country>
<value>Country</value>
<type>String</type>
</country>
<email>
<value>Email</value>
<type>String</type>
</email>
<company>
<value>Company</value>
<type>String</type>
</company>
<site-category>
<value>A</value>
<type>String</type>
</site-category>
</instance>
</model>
</retrieve-location-request>
</parameters>
</request>
</hp-service-manager-request>
The following figure displays an adapter response for the Find Location operation.
Sample adapter response for the Find Location operation
<hp-service-manager-response>
<metadata>
<count>1</count>
</metadata>
<responses>
<response>
<metadata>
<count>1</count>
</metadata>
<item>
<metadata>
<status>success</status>
</metadata>
<parameters>
<model>
<keys>
<location>
<value>MyLocation25</value>
<type>String</type>
</location>
</keys>
<instance>
<location-name>
<value>Location Name</value>
<type>String</type>
</location-name>
<location>
<value>MyLocation25</value>
<type>String</type>
</location>
<address>
<type>Array</type>
<address>
<element>
<value>Address</value>
<type>String</type>
</element>
</address>
</address>
<city>
<value>City</value>
<type>String</type>
</city>
<state>
<value>State</value>
<type>String</type>
</state>
<zip>
<value>zip</value>
<type>String</type>
</zip>
<primary-contact>
<comments>
<type>Array</type>
<comments>
<element>
<value>Comment line 1</value>
<type>String</type>
</element>
<element>
<value>Comment line 2</value>
<type>String</type>
</element>
</comments>
</comments>
<country>
<value>Country</value>
<type>String</type>
</country>
<email>
<value>Email</value>
<type>String</type>
</email>
<company>
<value>Company</value>
<type>String</type>
</company>
<location-structure>
<value>MyLocation25</value>
<type>String</type>
</location-structure>
<value>primary contact</value>
<type>String</type>
</primary-contact>
<phone>
<value>Phone</value>
<type>String</type>
</phone>
<location-open-time>
<value>11:00:00.000Z</value>
<type>Time</type>
</location-open-time>
<location-closing-time>
<value>12:00:00.000Z</value>
<type>Time</type>
</location-closing-time>
<primary-contact-department>
<value>primary contact department</value>
<type>String</type>
</primary-contact-department>
<location-code>
<value>LocationCode</value>
<type>String</type>
</location-code>
<location-full-name>
<value>Company/MyLocation25</value>
<type>String</type>
</location-full-name>
<site-category>
<value>A</value>
<type>String</type>
</site-category>
<uniquequery>location="MyLocation25"</uniquequery>
<recordid>MyLocation25</recordid>
</instance>
</model>
<status>SUCCESS</status>
<message>Success</message>
<schema-revision-date>2007.04.04 00:00:00</schema-revision-date>
<schema-revision-level>0</schema-revision-level>
<return-code>0</return-code>
</parameters>
</item>
</response>
</responses>
</hp-service-manager-response>
Comments
Log in or register to comment.