Service Provider Operations

This section documents the API operations for Service Provider service.

AddServiceProvider

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Add service provider: request

Properties

Property	Value
content	complex

Extends

Base type: spData:ServiceProviderInfo

Elements

Element	Type	Description
accountData:templateID	accountData:templateID (optional)
accountData:verbose	accountData:verbose (optional)
accountData:notifyOnly	accountData:notifyOnly (optional)
common:scope	common:scope (optional)
otherNotifyEmail	common:email (optional)	The email address where to send email when a new account is created; usually used in automation.
accountData:linkResourceID	accountData:linkResourceID (optional)
accountData:linkUUID	accountData:linkUUID (optional)
accountData:dku	accountData:dku (optional)
accountData:accountFlag	accountData:accountFlag (0..*)
(choice)		One of the following
└ accountData:parentID	accountData:parentID
└ accountData:parentIdentifier	accountData:parentIdentifier

XSD Source

xml

<xs:element name="AddServiceProvider">
  <xs:annotation>
    <xs:documentation>Add service provider: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="spData:ServiceProviderInfo">
          <xs:sequence>
            <xs:element name="accountData:templateID" type="accountData:templateID" minOccurs="0"/>
            <xs:element name="accountData:verbose" type="accountData:verbose" minOccurs="0"/>
            <xs:element name="accountData:notifyOnly" type="accountData:notifyOnly" minOccurs="0"/>
            <xs:element name="common:scope" type="common:scope" minOccurs="0"/>
            <xs:element name="otherNotifyEmail" type="common:email" minOccurs="0">
              <xs:annotation>
                <xs:documentation>The email address where to send email when a new account is created; usually used in automation.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="accountData:linkResourceID" type="accountData:linkResourceID" minOccurs="0"/>
            <xs:element name="accountData:linkUUID" type="accountData:linkUUID" minOccurs="0"/>
            <xs:element name="accountData:dku" type="accountData:dku" minOccurs="0"/>
            <xs:element name="accountData:accountFlag" type="accountData:accountFlag" minOccurs="0" maxOccurs="unbounded"/>
            <xs:choice>
              <xs:element name="accountData:parentID" type="accountData:parentID" minOccurs="0"/>
              <xs:element name="accountData:parentIdentifier" type="accountData:parentIdentifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

AddServiceProviderResponse

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Add service provider: response

Properties

Property	Value
content	complex

Extends

Base type: spData:ExtendedServiceProviderInfo

Elements

Element	Type	Description
common:result	common:result (optional)
common:notice	common:notice (0..*)

XSD Source

xml

<xs:element name="AddServiceProviderResponse">
  <xs:annotation>
    <xs:documentation>Add service provider: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="spData:ExtendedServiceProviderInfo">
          <xs:sequence>
            <xs:element name="common:result" type="common:result" minOccurs="0"/>
            <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditServiceProvider

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Edit service provider: request

Properties

Property	Value
content	complex

Extends

Base type: spData:ServiceProviderInfo

Elements

Element	Type	Description
(choice)		One of the following
└ common:ID	common:ID
└ common:identifier	common:identifier

XSD Source

xml

<xs:element name="EditServiceProvider">
  <xs:annotation>
    <xs:documentation>Edit service provider: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="spData:ServiceProviderInfo">
          <xs:sequence>
            <xs:choice>
              <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
              <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditServiceProviderResponse

Type: common:updateObject

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Edit service provider: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="EditServiceProviderResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit service provider: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetServiceProviderStatus

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Change service provider status:request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
accountData:status	accountData:status (optional)
accountData:phoneStatus	accountData:phoneStatus (optional)
common:scope	common:scope (optional)
(choice)		One of the following
└ common:ID	common:ID
└ common:identifier	common:identifier

XSD Source

xml

<xs:element name="SetServiceProviderStatus">
  <xs:annotation>
    <xs:documentation>Change service provider status:request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accountData:status" type="accountData:status" minOccurs="0"/>
        <xs:element name="accountData:phoneStatus" type="accountData:phoneStatus" minOccurs="0"/>
        <xs:element name="common:scope" type="common:scope" minOccurs="0"/>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
          <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

SetServiceProviderStatusResponse

Type: common:updateObject

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Change service provider status: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="SetServiceProviderStatusResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Change service provider status: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetServiceProviderCpAccess

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Change service provider control panel access:request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
accountData:cpAccess	accountData:cpAccess (optional)
(choice)		One of the following
└ common:ID	common:ID
└ common:identifier	common:identifier

XSD Source

xml

<xs:element name="SetServiceProviderCpAccess">
  <xs:annotation>
    <xs:documentation>Change service provider control panel access:request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accountData:cpAccess" type="accountData:cpAccess" minOccurs="0"/>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
          <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

SetServiceProviderCpAccessResponse

Type: common:updateObject

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Change service provider control panel access: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="SetServiceProviderCpAccessResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Change service provider control panel access: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetServiceProviders

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Get service providers: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
accountData:templateID	accountData:templateID (optional)
accountData:serverID	accountData:serverID (optional)
common:filter	common:filter (optional)
common:scope	common:scope (optional)
(choice)		One of the following
└ accountData:parentID	accountData:parentID
└ accountData:parentIdentifier	accountData:parentIdentifier

XSD Source

xml

<xs:element name="GetServiceProviders">
  <xs:annotation>
    <xs:documentation>Get service providers: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accountData:templateID" type="accountData:templateID" minOccurs="0"/>
        <xs:element name="accountData:serverID" type="accountData:serverID" minOccurs="0"/>
        <xs:element name="common:filter" type="common:filter" minOccurs="0"/>
        <xs:element name="common:scope" type="common:scope" minOccurs="0"/>
        <xs:choice>
          <xs:element name="accountData:parentID" type="accountData:parentID" minOccurs="0"/>
          <xs:element name="accountData:parentIdentifier" type="accountData:parentIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetServiceProvidersResponse

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Get service providers: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
serviceProvider	spData:ServiceProviderList (0..*)
common:notice	common:notice (0..*)

XSD Source

xml

<xs:element name="GetServiceProvidersResponse">
  <xs:annotation>
    <xs:documentation>Get service providers: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="serviceProvider" type="spData:ServiceProviderList" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetServiceProviderDetails

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Get details service provider data: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		One of the following
└ common:ID	common:ID
└ common:identifier	common:identifier

XSD Source

xml

<xs:element name="GetServiceProviderDetails">
  <xs:annotation>
    <xs:documentation>Get details service provider data: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
          <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetServiceProviderDetailsResponse

Type: spData:ExtendedServiceProviderInfo

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Get detailed service provider data: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="GetServiceProviderDetailsResponse" type="spData:ExtendedServiceProviderInfo">
  <xs:annotation>
    <xs:documentation>Get detailed service provider data: response</xs:documentation>
  </xs:annotation>
</xs:element>

DelServiceProvider

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Delete service provider: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		One of the following
└ common:ID	common:ID
└ common:identifier	common:identifier

XSD Source

xml

<xs:element name="DelServiceProvider">
  <xs:annotation>
    <xs:documentation>Delete service provider: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID"/>
          <xs:element name="common:identifier" type="common:identifier"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelServiceProviderResponse

Type: common:delObject

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Delete service porvider: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="DelServiceProviderResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete service porvider: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetServiceProviderPL

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Update service porvider preferences and limits: request

Properties

Property	Value
content	complex

Extends

Base type: spData:ServiceProviderPLInfo

Elements

Element	Type	Description
(choice)		One of the following
└ common:ID	common:ID
└ common:identifier	common:identifier

XSD Source

xml

<xs:element name="SetServiceProviderPL">
  <xs:annotation>
    <xs:documentation>Update service porvider preferences and limits: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="spData:ServiceProviderPLInfo">
          <xs:sequence>
            <xs:choice>
              <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
              <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

SetServiceProviderPLResponse

Type: common:updateObject

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Update service porvider references and limits: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="SetServiceProviderPLResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Update service porvider references and limits: response</xs:documentation>
  </xs:annotation>
</xs:element>

UpdateServiceProviderPL

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Update service provider preferences and limits: request

Properties

Property	Value
content	complex

Extends

Base type: spData:RelativeServiceProviderPLInfo

Elements

Element	Type	Description
(choice)		One of the following
└ common:ID	common:ID
└ common:identifier	common:identifier

XSD Source

xml

<xs:element name="UpdateServiceProviderPL">
  <xs:annotation>
    <xs:documentation>Update service provider preferences and limits: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="spData:RelativeServiceProviderPLInfo">
          <xs:sequence>
            <xs:choice>
              <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
              <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

UpdateServiceProviderPLResponse

Type: common:updateObject

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Update service porvider references and limits: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="UpdateServiceProviderPLResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Update service porvider references and limits: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetServiceProviderPL

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Get service provider preferences and limits: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		One of the following
└ common:ID	common:ID
└ common:identifier	common:identifier

XSD Source

xml

<xs:element name="GetServiceProviderPL">
  <xs:annotation>
    <xs:documentation>Get service provider preferences and limits: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID"/>
          <xs:element name="common:identifier" type="common:identifier"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetServiceProviderPLResponse

Namespace: http://4psa.com/ServiceProviderMessages.xsd/5.2.5

Description: Get service provider preferences and limits: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
userPL	spData:ServiceProviderPLInfo (optional)	Account preferences and limits
common:notice	common:notice (0..*)

XSD Source

xml

<xs:element name="GetServiceProviderPLResponse">
  <xs:annotation>
    <xs:documentation>Get service provider preferences and limits: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="userPL" type="spData:ServiceProviderPLInfo" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Account preferences and limits</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

Codes Returned by SystemAPI

Operations

Complex Data Types

Service Provider Operations ​

AddServiceProvider ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

Extends ​

Elements ​

XSD Source ​

EditServiceProvider ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

SetServiceProviderStatus ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

SetServiceProviderCpAccess ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

GetServiceProviders ​

Properties ​

Elements ​

XSD Source ​

Properties ​

Elements ​

XSD Source ​

GetServiceProviderDetails ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

DelServiceProvider ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

SetServiceProviderPL ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

UpdateServiceProviderPL ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

GetServiceProviderPL ​

Properties ​

Elements ​

XSD Source ​

Properties ​

Elements ​

XSD Source ​

Service Provider Operations

AddServiceProvider

Properties

Extends

Elements

XSD Source

Properties

Extends

Elements

XSD Source

EditServiceProvider

Properties

Extends

Elements

XSD Source

Properties

XSD Source

SetServiceProviderStatus

Properties

Elements

XSD Source

Properties

XSD Source

SetServiceProviderCpAccess

Properties

Elements

XSD Source

Properties

XSD Source

GetServiceProviders

Properties

Elements

XSD Source

Properties

Elements

XSD Source

GetServiceProviderDetails

Properties

Elements

XSD Source

Properties

XSD Source

DelServiceProvider

Properties

Elements

XSD Source

Properties

XSD Source

SetServiceProviderPL

Properties

Extends

Elements

XSD Source

Properties

XSD Source

UpdateServiceProviderPL

Properties

Extends

Elements

XSD Source

Properties

XSD Source

GetServiceProviderPL

Properties

Elements

XSD Source

Properties

Elements

XSD Source