ServiceGrid Article - FunctionPort Soap

From DocWiki

Jump to: navigation, search

Contents

Overview

SD SOAP API

Methods Deployed

(OpenEngine WSDL file). The request type and parameters are contained in the XML content of the message. oeRequest sends a request to the SD SOAP server and receives resulting content as XML.

WSDL

Please find the SD OpenEngine WSDL file at:

https://sdcall.solvedirect.com/webservices/SDOpenEngine.wsdl

Data Model

For better understanding of the different request types, have a look at the ServiceGrid data model in SD Data Objects and Views. The ServiceGrid WEB Interface ( https://sdcall.solvedirect.com ) gives a good example of functions and data used in the ServiceGrid application.

Request types

Request Result

Authentication

  • request User - The basic data of the requested user is the result. The client should initially use the request to make sure that the login data (SDUser, SDPassword) is complete and correct.
  • request CallSLASummary - A table containing the number of calls within time periods and/or categories is the result.
  • request Call - The data of a single call is the result.
  • request Calls - A list of calls is the result.
  • request Contracts - A list of contracts is the result.
  • request Contract - The data of a single contract is the result.
  • request SLA - A service level agreement within a contract is the result.

Inventory

  • request DeviceSummary - The number of devices within certain categories is the result
  • request Devices - A list of devices is the result.
  • request Device - The basic data of a single device is the result.
  • request ChangeDeviceCommitment - The service level commitment flags can be set.

Authentication

Request User

Request Example:

<!--?xml version="1.0" encoding="ISO-8859-1"?-->
<sdrequest>
<action returntype="“xml“"> RequestUser </action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
</sdrequest>

Action: “RequestUser“ Attribute:{ReturnType}(xml)
Authentication: SDUser, SDPassword, {SDRole} (SC oder SP (SC=Service Customer, SP=Service Provider)), Portal, PortalPassword

Parameter: Result: Userdata + all organizations where the user is member.

The tag SDRole can be ommitted, if the user role is unambigous.

PermissionGroups

Each user is mapped to a permision group.The permission group defines the access right of the user.

ServiceGrid permission groups

ID
ShortName Name
110
BpartnerAdm
BpartnerAdm
120
BPPersonAdm
BPPersonAdm
130
ContractAdm
ContractAdm
140
CallAdm
CallAdm
150
CallTracking
CallTracking
200
Demo
Demo
210
Nothing
No Permissions










After having received a request, the SD server application checks if the user has necessary access rights to execute this request. The permission group of the user together with memebrships of the user within organizations, defines the scope of date that the user may request and view.

Result Example:

<!--?xml version="1.0" encoding="ISO-8859-1"?-->
<user>
<shortname> mmayer </shortname>
<firstname> Martin </firstname>
<lastname> Mayer </lastname>
<tel> 876456 </tel>
<mobiletel> 0660/234678 </mobiletel>
<locationzip> 1010 </locationzip>
<locationcity> Wien </locationcity>
<locationstreet> Stephansplatz 1 </locationstreet>
<locationcountry> Austria </locationcountry>
<location> Zentrale </location>
<email> mm@xyz.com </email>
<comment1> Peter Bauer </comment1>
<comment2> +43 (051707) 79450 </comment2>
<comment3> +43 (676) 4912906 </comment3>
<comment4> peter.bauer@company.com </comment4>
<comment5>
<permissiongroup>
<id> 130 </id>
<name> ContractAdm </name>
</permissiongroup>
<organization nr="”0”">
<bpartner.shortname> SPNAME </bpartner.shortname>
<bpartner.name> SP Services </bpartner.name>
<shortname> FS/at </shortname>
<name> Field Service AT </name>
</organization>
<organization nr="”1”">
<bpartner.shortname> SPNAME </bpartner.shortname>
<bpartner.name> SP Services </bpartner.name>
<shortname> FS/de </shortname>
<name> Field Service DE </name>
</organization>
</comment5>
</user>


Calls, SLA and Contracts

Request CallSLASummary

Action: “RequestCallSLASummary“

Attribute: { ReturnType } (xml)

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: GroupBy (Month/Day/Hour/Weekday) Category (Provider/Customer/Manufacturer/Location/ProductClass) Fulfillment (Response/Recovery) CallOpenFrom CallOpenTo { Provider } { Customer } { Manufacturer } { Location } { ProductClass }

Result: Sum (InTime,InProgress,Overdue) of Calls cumulated per category (Provider/Customer/Manufacturer/Location/ProductClass) and per group (month, day, hour, weekday)

Request Example:

<!--?xml version="1.0" encoding="ISO-8859-1"?-->
<sdrequest>
<action returntype="“xml“"> RequestCallSLASummary </action>
<authentification>
<sduser> mayer </sduser>“
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<groupby> Month </groupby>
<category> Manufacturer </category>
<fulfillment> Response </fulfillment>
<callopenfrom> 2003-01-01 </callopenfrom>
<callopento> 2003-04-04 </callopento>
</parameters>
</sdrequest>


Result Example:

<!--?xml version="1.0" encoding="ISO-8859-1"?-->
<callslasummary category="”Provider”">
<row label="”Compaq”">
<column month="”1”" year="”2003”">
<intime> 12 </intime>
<inprogress> 24 </inprogress>
<overdue> 3 </overdue>
</column>
<column month="”2”" year="”2003”">
<intime> 8 </intime>
<inprogress> 5 </inprogress>
<overdue> 1 </overdue>
</column>
<column month="”3”" year="”2003”">
<intime> 56 </intime>
<inprogress> 8 </inprogress>
<overdue> 5 </overdue>
</column>
<column month="”4”" year="”2003”">
<intime> 10 </intime>
<inprogress> 12 </inprogress>
<overdue> 0 </overdue>
</column>
</row>
<row label="”FSC”">
<column month="”1”" year="”2003”">
<intime> 3 </intime>
<inprogress> 0 </inprogress>
<overdue> 2 </overdue>
</column>
<column month="”3”" year="”2003”">
<intime> 78 </intime>
<inprogress> 13 </inprogress>
<overdue> 12 </overdue>
</column>
<column month="”4”" year="”2003”">
<intime> 23 </intime>
<inprogress> 19 </inprogress>
<overdue> 1 </overdue>
</column>
</row>
</callslasummary>


Request Call

Action: “RequestCall“

Attribute: { ReturnType } (xml)

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: SDCallID

Result: Data of one Call with the requested SDCallID

Request Example:

<!--?xml version="1.0" encoding="ISO-8859-1"?-->
<sdrequest>
<action returntype="“xml“"> RequestCall </action>
<authentification>
<sduser> mayer </sduser>“
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<sdcallid> 976453 </sdcallid>
</parameters>
</sdrequest>

Result Example:

<call>
<sdcallid> 1001235 </sdcallid>
<custcallid> 7421 </custcallid>
<spcallid> 601/3766 </spcallid>
<callstate> Neu </callstate>
<customerpriority> high </customerpriority>
<problemstarttime> 2002-03-20 10:33 </problemstarttime>
<callopen> 2002-03-20 10:33 </callopen>
<callreceive> 2002-03-20 10:35 </callreceive>
<callacknowledge> 2002-03-20 10:36 </callacknowledge>
<callresponse> 2002-03-20 11:03 </callresponse>
<callclose> 2002-03-20 14:45 </callclose>
<description> Mausrad kaputt </description>
<remarks> Mausrad getauscht </remarks>
<slafulfillmentrs> InTime </slafulfillmentrs>
<slafulfillmentrc> InTime </slafulfillmentrc>
<maincomponent>
<type> 76342 </type>
<manufacturer> Logitech </manufacturer>
<productclass> Maus </productclass>
<unspsc> 43172207 </unspsc>
<sernr> 42543 </sernr>
<location> Hauptbüro </location>
<description> PC </description>
<shortname> PC001 </shortname>
</maincomponent>
<contract>
<shortname> SPNAME-CUST </shortname>
<sla> SL1 </sla>
<customer> Lotto </customer>
<provider> SPNAME </provider>
</contract>
<contact>
<lastname> Berger </lastname>
<firstname> Gerhard </firstname>
<tel> 442266 </tel>
</contact>
<helpdesk>
<lastname> Berger </lastname>
<firstname> Gerhard </firstname>
<tel> 442266 </tel>
</helpdesk>
<caller>
<lastname> Meier </lastname>
<firstname> Hans </firstname>
<tel> NV </tel>
</caller>
</call>

Request Calls

Action: “RequestCalls“

Attribute: { ReturnType } (xml/csv/xls) { PageNo } { Records } { Delimiter }

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: CallOpenFrom CallOpenTo {Provider} {Customer} {Manufacturer} {Location} {ProductClass} {SLAFulfillmentRs} (All/InTime/InProgress/Overdue) (Rs…Response) {SLAFulfillmentRc} (All/InTime/InProgress/Overdue) (Rc…Recovery) {IsTestCall} (All/Yes/No)

Result: A list of Calls

The selection parameter “IsTestCall” has only an effect if the column “IsTestCall” is part of the result xml structure. This field can be added by the open engine calltracking setup administration. The list will be delivered pagewise, each page containing 20 Calls. If no specific page number is requested, then page 1 is the result. In the result XML, the page number is found as attribute of the root tag.

Request Example:

<action returntype="“xml“" records="“50“" pageno="“2“">
RequestCalls
</action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<callopenfrom> 2002-03-20 </callopenfrom>
<callopento> 2002-03-21 </callopento>
<provider> SPNAME IT Service </provider>
<customer> Customer Customer HD </customer>
<manufacturer> SNI </manufacturer>
<location> Zentrale </location>
<productclass> Desktop </productclass>
<slafulfillmentrs> InTime </slafulfillmentrs>
<slafulfillmentrc> All </slafulfillmentrc>
</parameters>

Result Example:

<call nr="”0”">
<sdcallid> 1234567 </sdcallid>
<custcallid> 18453 </custcallid>
<spcallid> 746661 </spcallid>
<callopen> 2003-03-01 12:00 </callopen>
<callclose> 2003-03-05 12:00 </callclose>
<description> Mausrad kaputt </description>
<remarks> Mausrad getauscht </remarks>
<customerpriority> Mittlere Priorität </customerpriority>
<slafulfillmentrs> InTime </slafulfillmentrs>
<slafulfillmentrc> InTime </slafulfillmentrc>
<maincomponent>
<location> Zentrale </location>
<manufacturer> SNI </manufacturer>
<productclass> Maus </productclass>
<type> 76342 </type>
<model> </model>
<sernr> 42543 </sernr>
<unspsc> 43172207 </unspsc>
</maincomponent>
<provider> SPNAME IT Service </provider>
<customer> Customer Customer HD </customer>
</call>
<call nr="”1”">
<sdcallid> 1234568 </sdcallid>
<custcallid> 18455 </custcallid>
<spcallid> 746634 </spcallid>
<callopen> 2003-03-01 13:00 </callopen>
<callclose> 2003-03-01 17:00 </callclose>
<description> Controller raucht </description>
<remarks> Getauscht </remarks>
<customerpriority> Hohe Priorität </customerpriority>
<slafulfillmentrs> InTime </slafulfillmentrs>
<slafulfillmentrc> InTime </slafulfillmentrc>
<maincomponent>
<location> Zentrale </location>
<manufacturer> SNI </manufacturer>
<productclass> Desktop </productclass>
<type> CR540 </type>
<model> </model>
<sernr> 4254312 </sernr>
<unspsc> 43172207 </unspsc>
</maincomponent>
<provider> SPNAME IT Service </provider>
<customer> Customer Customer HD </customer>
</call>

Request Contracts

Action: “RequestContracts“

Attribute: { ReturnType } (xml/csv/xls) { PageNo } { Records } { Delimiter }

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: { Customer } { Provider } { Contract }

Result: List of contracts, contractelements and number of devices


Request Example:

<action returntype="“xml“" records="“50“" pageno="“2“">
RequestContracts
</action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<provider> SPNAME IT Service </provider>
<customer> Customer Customer HD </customer>
</parameters>

Result Example:

<contract nr="”0”">
<id> 26336 </id>
<customer> Customer Customer HD </customer>
<provider> SPNAME IT Service </provider>
<shortname> PC </shortname>
<sla nr="”0”">
<id> 26337 </id>
<shortname> SL1 </shortname>
<numberofdevices> 250 </numberofdevices>
</sla>
<sla nr="”1”">
<id> 26338 </id>
<shortname> SL2 </shortname>
<numberofdevices> 125 </numberofdevices>
</sla>
</contract>
<contract nr="”1”">
<id> 26339 </id>
<customer> Customer Customer HD </customer>
<provider> SPNAME IT Service </provider>
<shortname> Printer </shortname>
<sla nr="”0”">
<id> 26340 </id>
<shortname> SL1 </shortname>
<numberofdevices> 50 </numberofdevices>
</sla>
<sla nr="”1”">
<id> 26341 </id>
<shortname> SL2 </shortname>
<numberofdevices> 75 </numberofdevices>
</sla>
</contract>

The list will be delivered pagewise, each page containing 20 Calls. If no specific page number is requested, page 1 is the result. In the result XML, the page number is found as attribute of the root tag.

Request Contract

Action: “RequestContract“

Attribute: { ReturnType } (xml)

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: ID

Result: Data of 1 contract

Request Example:

<!--?xml version="1.0" encoding="ISO-8859-1"?--><sdrequest>
<action returntype="“xml“"> RequestContract </action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<id> 26336 </id>
</parameters>
</sdrequest>

Result Example:

<!--?xml version="1.0" encoding="ISO-8859-1"?-->
<contract>
<id> 26336 </id>
<shortname> PC </shortname>
<name> SPNAME Servicevertrag </name>
<validfrom> 2000-12-01 </validfrom>
<validuntil> 2005-11-30 </validuntil>
<customer>
<name> Customer Customer HD </name>
<contractid> 1002003 </contractid>
<providerid> 123450 </providerid>
</customer>
<provider>
<name> SPNAME IT Service </name>
<contractid> A34567 </contractid>
<customerid> 668877 </customerid>
</provider>
</contract>

Request SLA

Action: “RequestSLA“

Attribute: { ReturnType } (xml)

Authentication: SDUser SDPassword {SDRole}

Parameter: ID

Result: Detail of 1 SLA (Contractelement)

Request Example:

<!--?xml version="1.0" encoding="ISO-8859-1"?-->
<sdrequest>
<action returntype="“xml“"> RequestSLA </action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<id> 26337 </id>
</parameters>
</sdrequest>

Result Example:

<!--?xml version="1.0" encoding="ISO-8859-1"?-->
<sla>
<id> 26337 </id>
<shortname> SL1 </shortname>
<contract> PC </contract>
<customer> Customer Customer HD </customer>
<contractidcustomer> 1002003-001 </contractidcustomer>
<provider> SPNAME IT Service </provider>
<contractidprovider> A34567/1 </contractidprovider>
<validfrom> 2000-12-01 </validfrom>
<validuntil> 2005-11-30 </validuntil>
<responsetime> 4 </responsetime>
<recoverytime> 8 </recoverytime>
<servicetimes>
<mondayfrom> 08:00 </mondayfrom>
<mondayto> 24:00 </mondayto>
<tuesdayfrom> 00:00 </tuesdayfrom>
<tuesdayto> 24:00 </tuesdayto>
<wednesdayfrom> 00:00 </wednesdayfrom>
<wednesdayto> 24:00 </wednesdayto>
<thurdayfrom> 00:00 </thurdayfrom>
<thurdayto> 24:00 </thurdayto>
<fridayfrom> 00:00 </fridayfrom>
<fridayto> 13:00 </fridayto>
<saturfrom> 00:00 </saturfrom>
<saturdayto> 00:00 </saturdayto>
<sundayfrom> 00:00 </sundayfrom>
<sundayto> 00:00 </sundayto>
</servicetimes>
<isactiv> Y </isactiv>
<numberofdevices> 250 </numberofdevices>
<extensions>
<extension nr="”0”">
<priority> Auftrag-Auftrag </priority>
<responsetime> 0 </responsetime>
<recoverytime> 120 </recoverytime>
</extension>
<extension nr="”1”">
<priority> Betriebsstörend-Betriebsstörend </priority>
<responsetime> 0 </responsetime>
<recoverytime> 6 </recoverytime>
</extension>
<extension nr="”2”">
<priority> Hoch-Hoch </priority>
<responsetime> 0 </responsetime>
<recoverytime> 24 </recoverytime>
</extension>
<extension nr="”3”">
<priority> Niedrig-Niedrig </priority>
<responsetime> 0 </responsetime>
<recoverytime> 24 </recoverytime>
</extension>
</extensions>
</sla>

Inventory

Request DeviceSummary

Action: “RequestDeviceSummary”

Attribute: { ReturnType } (xml) { PageNo } { Records }

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: { Manufacturer } { ProductClass } { Type } { Model } { IsActiv } { Provider } { Customer } { ContractSLA } { ProviderCommitment} { CustomerCommitment } { Zip } { Location } { GroupBy } (Manufacturer/ProductClass/Type/Model/IsActiv/ Provider/Customer/ContractSLA/ProviderCommitment/ CustomerCommitment/Zip/Location)

Result: Sum of the selected devices grouped by the requested attributes.

Request Example:

<action returntype="“xml“" records="“50“" pageno="“2“">
 RequestDeviceSummary
</action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<productclass> Desktop </productclass>
<manufacturer> FSC </manufacturer>
<groupby> Type,Location </groupby>
</parameters>

The parameter GroupBy contains the name of the grouped columns. The entries must be delimited by comma.

Result Example:

<line nr="”0”">
 <location>
<shortname> Zimmer 4713 </shortname>
<zip> 1781 </zip>
</location>
<devicetype>
<productclass> Desktop </productclass>
<manufacturer> FSC </manufacturer>
</devicetype>
<numberofdevices> 2 </numberofdevices>
</line>
<line nr="”1”">
<location>
<shortname> Zimmer 4745 </shortname>
<zip> 1781 </zip>
</location>
<devicetype>
<productclass> Desktop </productclass>
<manufacturer> FSC </manufacturer>
</devicetype>
<numberofdevices> 3 </numberofdevices>
</line>


Request Devices

Action: “RequestDevices”

Attribute: { ReturnType } (xml/csv/xls) { PageNo } { Records } { Delimiter }

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: { ProductClass } { Manufacturer } { Customer } { Provider } { Contract } { SLA } { Location } { ProviderCommitment } { CustomerCommitment } { Active }

Result: List of requested devices.

Request Example:

<action returntype="“xml“" records="“50“" pageno="“2“">
RequestDevices
</action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpasswor Y </customercommitment>
<active> Y </active>d> xyz </portalpassword>
</authentification>
<parameters>
<productclass> Desktop </productclass>
<manufacturer> FSC </manufacturer>
<customer> Customer Customer HD </customer>
<provider> SPNAME IT Service </provider>
<contract> PC </contract>
<providercommitment> Y </providercommitment>
<customercommitment>
</parameters>

Result Example:

<device nr="”0”">
<devicetype>
<unspsc> 43171803 </unspsc>
<productclass> Desktop </productclass>
<manufacturer> FSC </manufacturer>
<type> 76342 </type>
<model> 100 </model>
</devicetype>
<location>
<shortname> Zentrale </shortname>
<zip> 1130 </zip>
</location>
<contract>
<shortname> PC </shortname>
<sla> SL1 </sla>
<customer> Customer Customer HD </customer>
<provider> SPNAME IT Service </provider>
</contract>
<sernr> 42543 </sernr>
<installdate> 2000-02-20 </installdate>
<active> Y </active>
<providercommitment> Y </providercommitment>
<customercommitment> Y </customercommitment>
</device>
<device nr="”1”">
<devicetype>
<unspsc> 43171803 </unspsc>
<productclass> Desktop </productclass>
<manufacturer> FSC </manufacturer>
<type> 1205 </type>
<model> </model>
</devicetype>
<location>
<shortname> Zentrale </shortname>
<zip> 1130 </zip>
</location>
<contract>
<shortname> PC </shortname>
<sla> SL2 </sla>
<customer> Customer Customer HD </customer>
<provider> SPNAME IT Service </provider>
</contract>
<sernr> 56743 </sernr>
<installdate> 1999-09-10 </installdate>
<active> Y </active>
<providercommitment> Y </providercommitment>
<customercommitment> Y </customercommitment>
</device>

The list will be delivered pagewise, each page containing 20 Calls. If no specific page number is requested, page 1 is the result. In the result XML, the page number is found as attribute of the root tag.

Request Device

Action: “RequestDevice”

Attribute: { ReturnType } (xml)

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: Manufacturer Type Model SerNr

Result: Data of 1 device

Request Example:

<action returntype="“xml“"> RequestDevice </action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<manufacturer> FSC </manufacturer>
<type> 76342 </type>
<model> 100 </model>
<sernr> 42543 </sernr>
</parameters>

Result Example:

<devicetype>
<unspsc> 43171803 </unspsc>
<productclass> Desktop </productclass>
<manufacturer> FSC </manufacturer>
<type> 76342 </type>
<model> 100 </model>
</devicetype>
<location>
<shortname> Z4713 </shortname>
<name> Zimmer 4713 </name>
<street> Hauptstr.12 </street>
<country> Österreich </country>
<zip> 1781 </zip>
<city> Wien </city>
</location>
<contract>
<customer> Customer Customer HD </customer>
<provider> SPNAME IT Service </provider>
<shortname> PC </shortname>
<sla> SL1 </sla>
</contract>
<warranty>
<type> On Site </type>
<startdate> 1999-05-20 </startdate>
<enddate> 2002-05-19 </enddate>
</warranty>
<sernr> 42543 </sernr>
<invnr> 1120 </invnr>
<installationdate> 1999-05-20 </installationdate>
<active> Y </active>
<providercommitment> Y </providercommitment>
<customercommitment> Y </customercommitment>

Request ChangeDeviceCommitment

Action: “ChangeDeviceCommitment”

Attribute: { ReturnType } (xml)

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: Manufacturer Type Model SerNr { ProviderCommitment } { CustomerCommitment }

Result: No result

Request Example:

<action returntype="“xml“"> ChangeDeviceCommitment </action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<manufacturer> FSC </manufacturer>
<type> Customer Customer HD </type>
<model> SPNAME IT Service </model>
<sernr> PC </sernr>
<providercommitment> Y </providercommitment>
<customercommitment> Y </customercommitment>
</parameters>

Request Locations

Action: “RequestLocations1”

Attribute: { ReturnType } (xml/csv/xls) { PageNo } { Records } { Delimiter }

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: { ShortName } { LocationCategory }

Result: List of requested locations.

Request Example:

<action returntype="“xml“" records="“50“" pageno="“1“">
RequestLocations1
</action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<shortname> D% </shortname>
<locationcategory> Lager </locationcategory>
</parameters>

Result Example:

<location nr="”0”">
<shortname> D1000 </shortname>
<name> ADM 1001 </name>
<city> Wien </city>
<street> Logistikstrasse 10 </street>
<country> AT </country>
<sysspecfield1> Kühllager </sysspecfield1>
<sysspecfield2> 5000m2 </sysspecfield2>
<locationcategory> Lager </locationcategory>
</location>

The list will be delivered pagewise, each page containing 20 Calls. If no specific page number is requested, page 1 is the result. In the result XML, the page number is found as attribute of the root tag.

Action: “RequestLocations2”

Attribute: { ReturnType } (xml/csv/xls) { PageNo } { Records } { Delimiter }

Authentication: SDUser SDPassword {SDRole} Portal PortalPassword

Parameter: { ShortName } { LocationState } { LocationCategory }

Result: List of requested locations.

Request Example:

<action returntype="“xml“" records="“50“" pageno="“1“">
RequestLocations2
</action>
<authentification>
<sduser> mayer </sduser>
<sdpassword> xyz </sdpassword>
<sdrole> SC </sdrole>
<portal> myPortal.com </portal>
<portalpassword> xyz </portalpassword>
</authentification>
<parameters>
<shortname> D% </shortname>
<locationstate> In Planung </locationstate>
<locationcategory> Lager </locationcategory>
</parameters>

Result Example:

<location nr="”0”">
<shortname> D1000 </shortname>
<name> ADM 1001 </name>
<city> Wien </city>
<zip> 1050 </zip>
<country> AT </country>
<locationstate> In Planung </locationstate>
<sysspecfield1> 5000m2 </sysspecfield1>
<sysspecfield3> -8 Grad </sysspecfield3>
<sysspecfield4> Lebensmittel </sysspecfield4>
<sysspecfield5> Milchprodukte </sysspecfield5>
<sysspecfield6> Auslieferung </sysspecfield6>
<locationcategory> Lager </locationcategory>
<contact>
<lastname> Berger </lastname>
<firstname> Hans </firstname>
</contact>
</location>

The list will be delivered pagewise, each page containing 20 Calls. If no specific page number is requested, page 1 is the result. In the result XML, the page number is found as attribute of the root tag.



For a complete list of Cisco ServiceGrid Articles, go to the List of Articles page.


Rating: 0.0/5 (0 votes cast)

Personal tools