Client Operations

This section documents the API operations for Client service.

AddClient

AddClientRequest

Type: data:ClientInfo

Namespace: http://4psa.com/ClientMessages.xsd/1.5

Description: Add client request.

Properties

Property	Value
content	complex

XSD Source

<xs:element name="AddClientRequest" type="data:ClientInfo">
  <xs:annotation>
    <xs:documentation>Add client request.</xs:documentation>
  </xs:annotation>
</xs:element>

AddClientResponse

Type: messagesInfo:UpdateClientResponseType

Namespace: http://4psa.com/ClientMessages.xsd/1.5

Description: Add client response.

Properties

Property	Value
content	complex

XSD Source

<xs:element name="AddClientResponse" type="messagesInfo:UpdateClientResponseType">
  <xs:annotation>
    <xs:documentation>Add client response.</xs:documentation>
  </xs:annotation>
</xs:element>

---

EditClient

EditClientRequest

Namespace: http://4psa.com/ClientMessages.xsd/1.5

Description: Edit client request

Properties

Property	Value
content	complex

Extends

Base type: data:ClientInfo

Elements

Element	Type	Description
clientId	common:idType (optional)
cpAccess	common:boolean (optional)
status	common:boolean (optional)

XSD Source

<xs:element name="EditClientRequest">
  <xs:annotation>
    <xs:documentation>Edit client request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:ClientInfo">
          <xs:sequence>
            <xs:element name="clientId" type="common:idType" minOccurs="0"/>
            <xs:element name="cpAccess" type="common:boolean" minOccurs="0"/>
            <xs:element name="status" type="common:boolean" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditClientResponse

Type: messagesInfo:UpdateClientResponseType

Namespace: http://4psa.com/ClientMessages.xsd/1.5

Description: Edit client response.

Properties

Property	Value
content	complex

XSD Source

<xs:element name="EditClientResponse" type="messagesInfo:UpdateClientResponseType">
  <xs:annotation>
    <xs:documentation>Edit client response.</xs:documentation>
  </xs:annotation>
</xs:element>

---

GetClient

GetClientRequest

Namespace: http://4psa.com/ClientMessages.xsd/1.5

Description: Get clients list

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		Either of
└ clientId	common:idType	Client id
└ filter	common:string255	Filter client by name, company, email, login

XSD Source

<xs:element name="GetClientRequest">
  <xs:annotation>
    <xs:documentation>Get clients list</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="clientId" type="common:idType" minOccurs="0"/>
          <xs:element name="filter" type="common:string255" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetClientResponse

Type: messagesInfo:GetClientResponseType

Namespace: http://4psa.com/ClientMessages.xsd/1.5

Description: Get clients response.

Properties

Property	Value
content	complex

XSD Source

<xs:element name="GetClientResponse" type="messagesInfo:GetClientResponseType">
  <xs:annotation>
    <xs:documentation>Get clients response.</xs:documentation>
  </xs:annotation>
</xs:element>

---

DelClient

DelClientRequest

Namespace: http://4psa.com/ClientMessages.xsd/1.5

Description: Delete clients request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
clientId	common:idType (1..*)

XSD Source

<xs:element name="DelClientRequest">
  <xs:annotation>
    <xs:documentation>Delete clients request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="clientId" type="common:idType" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelClientResponse

Type: messagesInfo:DelClientResponseType

Namespace: http://4psa.com/ClientMessages.xsd/1.5

Description: Delete clients response.

Properties

Property	Value
content	complex

XSD Source

<xs:element name="DelClientResponse" type="messagesInfo:DelClientResponseType">
  <xs:annotation>
    <xs:documentation>Delete clients response.</xs:documentation>
  </xs:annotation>
</xs:element>

---