Projects:Web Services/Technical Specifications

Contents 1 Technical Specifications 1.1 New web services specification 1.2 Appendix 1.2.1 Unisys web services specification 1.2.2 Web services already included in Openbravo

Technical Specifications

New web services specification

• Service Name: getCustomerInformation
  • Input: int ClientID, int partnerId, String searchKey, String name, String username, String password
  • Output: Customer (extends BusinessPartner)
    • int id
    • int clientId
    • String name
    • String searchKey
    • Boolean complete
    • Boolean customer
    • Boolean vendor
    • Location[] locations
    • Contact[] contacts

• Service Name: updateCustomerInformation
  • Input: int ClientID, Customer partner, String username, String password
  • Output: Boolean (success / failure)

• Service Name: getCustomerContactList
  • Input: int ClientID, int customerId, String username, String password
  • Output: BPContactList
    • int[] ContactId
      

• Service Name: getCustomerContactInformation
  • Input: int ClientID, int partnerId, int contactId, String username, String password
  • Output: BPContactInfo
    • String PhoneNo
    • String AlternatePhoneNo
    • String FaxNo
    • String BusinessEmail

Appendix

Unisys web services specification

• Service Name: GetCustomerInformation
  • Input: login-name
  • Output: CustomerInformation
    • Name
    • Client
    • Organization
    • ShippingAddress
      

• Service Name: UpdateCustomerInformation
  • Input: CustomerInformation
    • login-name
    • Name
    • Client
    • Organization
    • ShippingAddress
  • Output: Result (success / failure)
    

• Service Name: GetCustomerContactInformation
  • Input: login-name
  • Output: CustomerContactInformation
    • PhoneNo
    • AlternatePhoneNo
    • FaxNo
    • BusinessEmail
      

• Service Name: GetOrderStatus
  • Input: login-name
  • Output: Collection of OrderStatus
    • OrderNo
    • OrderDate
    • OrderItem

Web services already included in Openbravo

• Service Name: getOrders
  • Input: int ClientID, int organizationId, OrderIdentifier[] orderIds, String username, String password
  • Output: Order[]
    • OrderIdentifier orderId
    • OrderLine [] lines
    • int state
    • BPartner businessPartner;
    • Payment[] payments