RestApi-Navigation » ServiceOperations

ServiceOperations

Zuletzt geändert von Thomas Hoffmann am 2013/11/12 15:43
Kommentare (0) · Anhänge (0) · Historie

Beschreibung

ServiceOperations sind vom System spezielle vorgegebene Funktionalitäten um Daten in unserem System abzurufen oder zu aktualisieren.

ServiceOperation

GetSalesOrderHistory

Diese ServiceOperation gibt Ihnen Informationen zu Änderungen an einem Entity im EntitySet SalesOrders zurück.


Diese ServiceOperation erlaubt nur die Request Methode:  GET.
 

Parameter

ParamterWerttypErläuterung
salesOrderIdInt64Entspricht der Id aus dem EntitySet SalesOrders.

Request

Das unten aufgeführten Beispiel bezieht sich auf das Entity mit der Id 1.


GET                     http://sandboxapi.via.de/publicapi/v1/api.svc/GetSalesOrderHistory?salesOrderId=1L

Request HTTP-Header


Content-Type:           application/xml
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request Body


Nicht erforderlich

Response

Response Header


Status Code:            200 OK
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Response Body


<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<GetSalesOrderHistory xml:space="preserve" xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices">31.10.2012 10:31:30 - ItemId 258187010 - Aktion MarkedAsPaid:1&#xD;31.10.2012 10:31:47 - ItemId 258187010 - Aktion Versandstatus:1&#xD;
</GetSalesOrderHistory>

Request HTTP-Header


Content-Type:           application/json
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request Body


Nicht erforderlich

Response

Response Header


Status Code:            200 OK
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Response Body

{
"d" : {
 "GetSalesOrderHistory" : "31.01.2013 10:31:30 - ItemId 258187010 - Aktion MarkedAsPaid:1\r\n31.01.2013 10:31:47 - ItemId 258187010 - Aktion Versandstatus:1\r\n"
 }
}


ProductIsListed

Mit dieser ServiceOperation kann geprüft werden, ob ein Produkt bei eBay eingestellt ist.


Diese ServiceOperation erlaubt nur die Request Methode:  GET.
 

Parameter

ParamterWerttypErläuterung
productIdInt64Entspricht der Id aus dem EntitySet Products.

Request

Das unten aufgeführten Beispiel bezieht sich auf das Entity mit der Id 1.


GET                     http://sandboxapi.via.de/publicapi/v1/api.svc/ProductIsListed?productId=1L

Request HTTP-Header


Content-Type:           application/xml
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request Body


Nicht erforderlich

Response

Response Header


Status Code:            200 OK
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Response Body



<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ProductIsListed p1:type="Edm.Boolean" xmlns:p1="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices">true</ProductIsListed>


Request HTTP-Header


Content-Type:           application/json
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request Body


Nicht erforderlich

Response

Response Header


Status Code:            200 OK
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Response Body


{
 "d": {
   "ProductIsListed": true
  }
}


Ist ein Produkt nicht bei eBay aktiv, wird im Response anstatt true false zurück gegeben.


SetEbayCategory

Mit dieser ServiceOperation können die eBay Kategorien 1 und 2 einem Produkt zugewiesen werden.


Diese ServiceOperation greift nur, wenn man bei dem EntitySet Products das Property DisableAutomatch mit True übergeben wird.
Andernfalls greift der interne Matchingprozess für die eBay Kategorievorschläge.

Hier findet man eine Liste von gültigen eBay Kategorie Ids:
http://listings.ebay.de/_W0QQloctZShowCatIdsQQsacatZQ2d1QQsalocationZlisQQsocmdZListingCategoryList


Diese ServiceOperation erlaubt nur die Request Methode:  POST.
 

Parameter

ParamterWerttypAngabeErläuterung
productIdInt64PflichtEntspricht der Id aus dem EntitySet Products
 
categoryId1Int64PflichtEnthält die eBay Kategorie 1

categoryId2Int64OptionalEnthält die eBay Kategorie 2

autoMatchedBooleanOptionalGibt an, ob das Produkt automatisch als gemachted gekennzeichnet werden soll.

Hinweis zu autoMatched:
Wird der Parameter mit true übergeben, können keine Eigenschaften bzw. Merkmale (ProductSpecifics) den eBay Merkmalen zugeordnet werden.
Somit werden alle Merkmale, die nicht zu 100% den eBay Merkmalen entsprechen als eigene Merkmale an eBay übergeben.

Request

Das unten aufgeführten Beispiel bezieht sich auf das Entity mit der Id 1.

Es wird die eBay Kategorie Sammeln und Seltenes > eBayana (#30726) und Sammeln und Seltenes > Disneyana > Vintage > Spielzeug (#60029) zugewiesen.


POST                    http://sandboxapi.via.de/publicapi/v1/api.svc/SetEbayCategory?productId=1L&categoryId1=30726&categoryId2=60029

Request HTTP-Header


Content-Type:           application/xml
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request Body


Nicht erforderlich

Response

Response Header


Status Code:            200 OK
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Response Body


<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<SetEbayCategory p1:type="Edm.Boolean">true</SetEbayCategory>

Request HTTP-Header


Content-Type:           application/json
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request Body


Nicht erforderlich

Response

Response Header


Status Code:            200 OK
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Response Body


{
d : {
SetEbayCategory : true
}
-
}


DeleteAccountData

Mit der ServiceOperation kann ein VIA-Connect Account geleert werden.


Diese ServiceOperation erlaubt nur die Request Methode:  POST.
 

Parameter

ParamterWerttypErläuterung
typeIntHier können folgende Werte angegeben werden:
0, 2, 4, 6, 8, 10, 12

Parameterdetails

typeErläuterung
0Es werden folgenden EntitySets geleert:
  • Products
  • Catalogs
  • SalesOrders
  • Buyers
  • Listings       
2Es werden folgenden EntitySets geleert:
  • Products       
4Es werden folgenden EntitySets geleert:
  • Catalogs      
6Es werden folgenden EntitySets geleert:
  • Products
  • Catalogs      
8Es werden folgenden EntitySets geleert:
  • SalesOrders
  • Buyers      
10Es werden folgenden EntitySets geleert:
  • Products
  • SalesOrders
  • Buyers       
12Es werden folgenden EntitySets geleert:
  • Catalogs
  • SalesOrders
  • Buyers      

Das Löschen des VIA-Connect Accounts hat keinen Einfluss auf aktive eBay-Artikel, dass heisst es werden keine aktiven Artikel beendet, wenn der VIA-Connect Account geleert wird.
 

Request

Im unteren Beispiel wird der Parameter type mit 0 gesendet. Damit werden die EntitySets Products, Catalogs, SalesOrders, Buyers, Listings  geleert.


POST                      http://sandboxapi.via.de/publicapi/v1/api.svc/DeleteAccountData?type=0

Request HTTP-Header


Content-Type:           application/xml
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request Body


Nicht erforderlich

Response

Response Header


Status Code:            200 OK
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Response Body


<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<DeleteAccountData p1:type="Edm.Boolean">true</DeleteAccountData>

Request HTTP-Header


Content-Type:           application/xml
Accept:                 application/json
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request Body


Nicht erforderlich

Response

Response Header


Status Code:            200 OK
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Response Body


{
d : {
DeleteAccountData : true
}
-
}

Tags:
Erstellt von Thomas Hoffmann am 2012/09/13 13:23

Copyright 2004-2023 XWiki