Account Operations
This section documents the API operations for Account service.
DelAccount
DelAccount
Namespace: http://4psa.com/AccountMessages.xsd/5.2.5
Description: Delete account: 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="DelAccount">
<xs:annotation>
<xs:documentation>Delete account: 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>DelAccountResponse
Type: common:delObject
Namespace: http://4psa.com/AccountMessages.xsd/5.2.5
Description: Delete account: response
Properties
| Property | Value |
|---|---|
| content | complex |
XSD Source
xml
<xs:element name="DelAccountResponse" type="common:delObject">
<xs:annotation>
<xs:documentation>Delete account: response</xs:documentation>
</xs:annotation>
</xs:element>SetAccountStatus
SetAccountStatus
Namespace: http://4psa.com/AccountMessages.xsd/5.2.5
Description: Change account status:request
Properties
| Property | Value |
|---|---|
| content | complex |
Elements
| Element | Type | Description |
|---|---|---|
| status | common:boolean (optional) | Account status |
| 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="SetAccountStatus">
<xs:annotation>
<xs:documentation>Change account status:request</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="status" type="common:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Account status</xs:documentation>
</xs:annotation>
</xs:element>
<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>SetAccountStatusResponse
Type: common:updateObject
Namespace: http://4psa.com/AccountMessages.xsd/5.2.5
Description: Change account status: response
Properties
| Property | Value |
|---|---|
| content | complex |
XSD Source
xml
<xs:element name="SetAccountStatusResponse" type="common:updateObject">
<xs:annotation>
<xs:documentation>Change account status: response</xs:documentation>
</xs:annotation>
</xs:element>LinkAccount
LinkAccount
Namespace: http://4psa.com/AccountMessages.xsd/5.2.5
Description: Link account to a remote account resource:request
Properties
| Property | Value |
|---|---|
| content | complex |
Elements
| Element | Type | Description |
|---|---|---|
| linkResourceID | common:integer (optional) | Linkage resource identifier |
| linkUUID | common:string (optional) | Remote linkage user identifier |
| forceUpdate | common:boolean (optional) | Force remote resource linkage identifier update |
| (choice) | One of the following | |
| └ common:ID | common:ID | |
| └ common:identifier | common:identifier | |
| └ login | common:string | Account username |
XSD Source
xml
<xs:element name="LinkAccount">
<xs:annotation>
<xs:documentation>Link account to a remote account resource:request</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="linkResourceID" type="common:integer" minOccurs="0">
<xs:annotation>
<xs:documentation>Linkage resource identifier</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="linkUUID" type="common:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Remote linkage user identifier</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="forceUpdate" type="common:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Force remote resource linkage identifier update</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice>
<xs:element name="common:ID" type="common:ID"/>
<xs:element name="common:identifier" type="common:identifier"/>
<xs:element name="login" type="common:string"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>LinkAccountResponse
Namespace: http://4psa.com/AccountMessages.xsd/5.2.5
Description: Link account to a remote account resource: response
Properties
| Property | Value |
|---|---|
| content | complex |
Extends
Base type: common:updateObject
XSD Source
xml
<xs:element name="LinkAccountResponse">
<xs:annotation>
<xs:documentation>Link account to a remote account resource: response</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:complexContent>
<xs:extension base="common:updateObject">
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>