Organization Operations

This section documents the API operations for Organization service.

AddOrganization

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

Description: Add organization: request

Properties

Property	Value
content	complex

Extends

Base type: organizationData:OrganizationInfo

Elements

Element	Type	Description
accountData:templateID	accountData:templateID (optional)
accountData:channelRuleID	accountData:channelRuleID (optional)
common:identifier	common:identifier (optional)
accountData:verbose	accountData:verbose (optional)
accountData:notifyOnly	accountData:notifyOnly (optional)
common:scope	common:scope (optional)
otherNotifyEmail	common:email (optional)	The email adress 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 (optional)
(choice)		One of the following
└ accountData:parentID	accountData:parentID
└ accountData:parentIdentifier	accountData:parentIdentifier
└ accountData:parentLogin	accountData:parentLogin

XSD Source

xml

<xs:element name="AddOrganization">
  <xs:annotation>
    <xs:documentation>Add organization: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="organizationData:OrganizationInfo">
          <xs:sequence>
            <xs:element name="accountData:templateID" type="accountData:templateID" minOccurs="0"/>
            <xs:element name="accountData:channelRuleID" type="accountData:channelRuleID" minOccurs="0"/>
            <xs:element name="common:identifier" type="common:identifier" 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" maxOccurs="1">
              <xs:annotation>
                <xs:documentation>The email adress 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"/>
            <xs:choice>
              <xs:element name="accountData:parentID" type="accountData:parentID" minOccurs="0"/>
              <xs:element name="accountData:parentIdentifier" type="accountData:parentIdentifier" minOccurs="0"/>
              <xs:element name="accountData:parentLogin" type="accountData:parentLogin" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

AddOrganizationResponse

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

Description: Add organization: response

Properties

Property	Value
content	complex

Extends

Base type: organizationData:ExtendedOrganizationInfo

Elements

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

XSD Source

xml

<xs:element name="AddOrganizationResponse">
  <xs:annotation>
    <xs:documentation>Add organization: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="organizationData:ExtendedOrganizationInfo">
          <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:element name="accountData:template" type="accountData:template" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditOrganization

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

Description: Edit organization: request

Properties

Property	Value
content	complex

Extends

Base type: organizationData:OrganizationInfo

Elements

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

XSD Source

xml

<xs:element name="EditOrganization">
  <xs:annotation>
    <xs:documentation>Edit organization: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="organizationData:OrganizationInfo">
          <xs:sequence>
            <xs:element name="accountData:templateID" type="accountData:templateID" minOccurs="0"/>
            <xs:element name="accountData:channelRuleID" type="accountData:channelRuleID" 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:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditOrganizationResponse

Type: common:updateObject

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

Description: Edit organization: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="EditOrganizationResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit organization: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetOrganizationStatus

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

Description: Change organization 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="SetOrganizationStatus">
  <xs:annotation>
    <xs:documentation>Change organization 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"/>
          <xs:element name="common:identifier" type="common:identifier"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

SetOrganizationStatusResponse

Type: common:updateObject

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

Description: Change organization status: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="SetOrganizationStatusResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Change organization status: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetOrganizationCpAccess

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

Description: Change organization control panel access:request

Properties

Property	Value
content	complex

Elements

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

XSD Source

xml

<xs:element name="SetOrganizationCpAccess">
  <xs:annotation>
    <xs:documentation>Change organization control panel access:request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accountData:cpAccess" type="accountData:cpAccess"/>
        <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>

SetOrganizationCpAccessResponse

Type: common:updateObject

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

Description: Change organization control panel access: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="SetOrganizationCpAccessResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Change organization control panel access: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetOrganizations

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

Description: Get organizations: 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="GetOrganizations">
  <xs:annotation>
    <xs:documentation>Get organizations: 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>

GetOrganizationsResponse

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

Description: Get organizations: response

Properties

Property	Value
content	complex

Elements

Element	Type	Description
organization	organizationData:OrganizationList (0..*)	Account data
common:notice	common:notice (0..*)

XSD Source

xml

<xs:element name="GetOrganizationsResponse">
  <xs:annotation>
    <xs:documentation>Get organizations: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="organization" type="organizationData:OrganizationList" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Account data</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetOrganizationDetails

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

Description: Get organization acccount details: 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="GetOrganizationDetails">
  <xs:annotation>
    <xs:documentation>Get organization acccount details: 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>

GetOrganizationDetailsResponse

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

Description: Get organization account details: response

Properties

Property	Value
content	complex

Extends

Base type: organizationData:ExtendedOrganizationInfo

XSD Source

xml

<xs:element name="GetOrganizationDetailsResponse">
  <xs:annotation>
    <xs:documentation>Get organization account details: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="organizationData:ExtendedOrganizationInfo">
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

DelOrganization

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

Description: Delete organizations: 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="DelOrganization">
  <xs:annotation>
    <xs:documentation>Delete organizations: 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>

DelOrganizationResponse

Type: common:delObject

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

Description: Delete organizations: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="DelOrganizationResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete organizations: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetOrganizationPL

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

Description: Update organization preferences and limits: request

Properties

Property	Value
content	complex

Extends

Base type: organizationData:OrganizationPLInfo

Elements

Element	Type	Description
organizationType	inline (optional)	Organization type: 0 for Business, 1 for Residential group. Default is 0.
(choice)		One of the following
└ common:ID	common:ID
└ common:identifier	common:identifier

XSD Source

xml

<xs:element name="SetOrganizationPL">
  <xs:annotation>
    <xs:documentation>Update organization preferences and limits: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="organizationData:OrganizationPLInfo">
          <xs:sequence>
            <xs:element name="organizationType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Organization type: 0 for Business, 1 for Residential group. Default is 0.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <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>

SetOrganizationPLResponse

Type: common:updateObject

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

Description: Update organization preferences and limits: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="SetOrganizationPLResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Update organization preferences and limits:
				response</xs:documentation>
  </xs:annotation>
</xs:element>

UpdateOrganizationPL

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

Description: Update organization preferences and limits: request

Properties

Property	Value
content	complex

Extends

Base type: organizationData:RelativeOrganizationPLInfo

Elements

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

XSD Source

xml

<xs:element name="UpdateOrganizationPL">
  <xs:annotation>
    <xs:documentation>Update organization preferences and limits: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="organizationData:RelativeOrganizationPLInfo">
          <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>

UpdateOrganizationPLResponse

Type: common:updateObject

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

Description: Update organization preferences and limits: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="UpdateOrganizationPLResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Update organization preferences and limits:
				response</xs:documentation>
  </xs:annotation>
</xs:element>

GetOrganizationPL

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

Description: Get organization 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="GetOrganizationPL">
  <xs:annotation>
    <xs:documentation>Get organization 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>

GetOrganizationPLResponse

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

Description: Get organization preferences and limits: response

Properties

Property	Value
content	complex

Elements

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

XSD Source

xml

<xs:element name="GetOrganizationPLResponse">
  <xs:annotation>
    <xs:documentation>Get organization preferences and limits: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="userPL" 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>

MoveOrganizations

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

Description: Move organizations to a specific service provider account: request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		One of the following
└ serviceProviderID	common:positiveInteger	New owner ID for organization accounts
└ serviceProviderIdentifier	common:string	New owner identifier for organization accounts

XSD Source

xml

<xs:element name="MoveOrganizations">
  <xs:annotation>
    <xs:documentation>Move organizations to a specific service provider account:
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="serviceProviderID" type="common:positiveInteger"/>
          <xs:element name="serviceProviderIdentifier" type="common:string"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

MoveOrganizationsResponse

Type: common:delObject

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

Description: Move organizations to a specific service provider account: response

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="MoveOrganizationsResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Move organizations to a specific service provider account:
				response</xs:documentation>
  </xs:annotation>
</xs:element>

Codes Returned by SystemAPI

Operations

Complex Data Types

Organization Operations ​

AddOrganization ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

Extends ​

Elements ​

XSD Source ​

EditOrganization ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

SetOrganizationStatus ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

SetOrganizationCpAccess ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

GetOrganizations ​

Properties ​

Elements ​

XSD Source ​

Properties ​

Elements ​

XSD Source ​

GetOrganizationDetails ​

Properties ​

Elements ​

XSD Source ​

Properties ​

Extends ​

XSD Source ​

DelOrganization ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

SetOrganizationPL ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

UpdateOrganizationPL ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

GetOrganizationPL ​

Properties ​

Elements ​

XSD Source ​

Properties ​

Elements ​

XSD Source ​

MoveOrganizations ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

Organization Operations

AddOrganization

Properties

Extends

Elements

XSD Source

Properties

Extends

Elements

XSD Source

EditOrganization

Properties

Extends

Elements

XSD Source

Properties

XSD Source

SetOrganizationStatus

Properties

Elements

XSD Source

Properties

XSD Source

SetOrganizationCpAccess

Properties

Elements

XSD Source

Properties

XSD Source

GetOrganizations

Properties

Elements

XSD Source

Properties

Elements

XSD Source

GetOrganizationDetails

Properties

Elements

XSD Source

Properties

Extends

XSD Source

DelOrganization

Properties

Elements

XSD Source

Properties

XSD Source

SetOrganizationPL

Properties

Extends

Elements

XSD Source

Properties

XSD Source

UpdateOrganizationPL

Properties

Extends

Elements

XSD Source

Properties

XSD Source

GetOrganizationPL

Properties

Elements

XSD Source

Properties

Elements

XSD Source

MoveOrganizations

Properties

Elements

XSD Source

Properties

XSD Source