Contacts
Click here for a complete list of operations.
GetGroups
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /post/Contacts.asmx HTTP/1.1
Host: api.payamak-panel.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetGroups"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetGroups xmlns="http://tempuri.org/">
<username>string</username>
<password>string</password>
</GetGroups>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetGroupsResponse xmlns="http://tempuri.org/">
<GetGroupsResult>
<GroupsList>
<GroupID>int</GroupID>
<ParentId>int</ParentId>
<UserID>int</UserID>
<GroupName>string</GroupName>
<GroupDescription>string</GroupDescription>
<GroupStatus>unsignedByte</GroupStatus>
<ContactCount>int</ContactCount>
<ShowToChild>boolean</ShowToChild>
<ChildsCount>int</ChildsCount>
</GroupsList>
<GroupsList>
<GroupID>int</GroupID>
<ParentId>int</ParentId>
<UserID>int</UserID>
<GroupName>string</GroupName>
<GroupDescription>string</GroupDescription>
<GroupStatus>unsignedByte</GroupStatus>
<ContactCount>int</ContactCount>
<ShowToChild>boolean</ShowToChild>
<ChildsCount>int</ChildsCount>
</GroupsList>
</GetGroupsResult>
</GetGroupsResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /post/Contacts.asmx HTTP/1.1
Host: api.payamak-panel.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetGroups xmlns="http://tempuri.org/">
<username>string</username>
<password>string</password>
</GetGroups>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetGroupsResponse xmlns="http://tempuri.org/">
<GetGroupsResult>
<GroupsList>
<GroupID>int</GroupID>
<ParentId>int</ParentId>
<UserID>int</UserID>
<GroupName>string</GroupName>
<GroupDescription>string</GroupDescription>
<GroupStatus>unsignedByte</GroupStatus>
<ContactCount>int</ContactCount>
<ShowToChild>boolean</ShowToChild>
<ChildsCount>int</ChildsCount>
</GroupsList>
<GroupsList>
<GroupID>int</GroupID>
<ParentId>int</ParentId>
<UserID>int</UserID>
<GroupName>string</GroupName>
<GroupDescription>string</GroupDescription>
<GroupStatus>unsignedByte</GroupStatus>
<ContactCount>int</ContactCount>
<ShowToChild>boolean</ShowToChild>
<ChildsCount>int</ChildsCount>
</GroupsList>
</GetGroupsResult>
</GetGroupsResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /post/Contacts.asmx/GetGroups?username=string&password=string HTTP/1.1 Host: api.payamak-panel.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfGroupsList xmlns="http://tempuri.org/">
<GroupsList>
<GroupID>int</GroupID>
<ParentId>int</ParentId>
<UserID>int</UserID>
<GroupName>string</GroupName>
<GroupDescription>string</GroupDescription>
<GroupStatus>unsignedByte</GroupStatus>
<ContactCount>int</ContactCount>
<ShowToChild>boolean</ShowToChild>
<ChildsCount>int</ChildsCount>
</GroupsList>
<GroupsList>
<GroupID>int</GroupID>
<ParentId>int</ParentId>
<UserID>int</UserID>
<GroupName>string</GroupName>
<GroupDescription>string</GroupDescription>
<GroupStatus>unsignedByte</GroupStatus>
<ContactCount>int</ContactCount>
<ShowToChild>boolean</ShowToChild>
<ChildsCount>int</ChildsCount>
</GroupsList>
</ArrayOfGroupsList>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /post/Contacts.asmx/GetGroups HTTP/1.1 Host: api.payamak-panel.com Content-Type: application/x-www-form-urlencoded Content-Length: length username=string&password=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfGroupsList xmlns="http://tempuri.org/">
<GroupsList>
<GroupID>int</GroupID>
<ParentId>int</ParentId>
<UserID>int</UserID>
<GroupName>string</GroupName>
<GroupDescription>string</GroupDescription>
<GroupStatus>unsignedByte</GroupStatus>
<ContactCount>int</ContactCount>
<ShowToChild>boolean</ShowToChild>
<ChildsCount>int</ChildsCount>
</GroupsList>
<GroupsList>
<GroupID>int</GroupID>
<ParentId>int</ParentId>
<UserID>int</UserID>
<GroupName>string</GroupName>
<GroupDescription>string</GroupDescription>
<GroupStatus>unsignedByte</GroupStatus>
<ContactCount>int</ContactCount>
<ShowToChild>boolean</ShowToChild>
<ChildsCount>int</ChildsCount>
</GroupsList>
</ArrayOfGroupsList>