GET v1/core/channels/{chnId}/accounts?adminemail={adminemail}&accountnumber={accountnumber}&foreignkey={foreignkey}&contactemail={contactemail}&cli={cli}
Returns the account uris for a specific channel
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| chnId | the channel id |
Define this parameter in the request URI. |
| adminemail | optional parameter to search for an account by the Admin's email |
Define this parameter in the request URI. |
| accountnumber | optional parameter to search for an account by the Account number |
Define this parameter in the request URI. |
| foreignkey | optional parameter to search for an account by a foreign key (supplied at account creation) |
Define this parameter in the request URI. |
| contactemail | No documentation available. |
Define this parameter in the request URI. |
| cli | No documentation available. |
Define this parameter in the request URI. |
Response Information
a list of uris to all the accounts
Response body formats
application/json, text/json
Sample:
{
"Success": true,
"Data": [
{
"AccountID": 1,
"Uri": "sample string 2"
},
{
"AccountID": 1,
"Uri": "sample string 2"
},
{
"AccountID": 1,
"Uri": "sample string 2"
}
],
"ErrorCode": 2,
"ErrorDescription": "sample string 3",
"Meta": "sample string 4"
}
text/javascript
Sample:
{"Success":true,"Data":[{"AccountID":1,"Uri":"sample string 2"},{"AccountID":1,"Uri":"sample string 2"},{"AccountID":1,"Uri":"sample string 2"}],"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}
application/xml, text/xml
Sample:
<PBNBReturnOfArrayOfAccountUriCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
<Data>
<AccountUri>
<AccountID>1</AccountID>
<Uri>sample string 2</Uri>
</AccountUri>
<AccountUri>
<AccountID>1</AccountID>
<Uri>sample string 2</Uri>
</AccountUri>
<AccountUri>
<AccountID>1</AccountID>
<Uri>sample string 2</Uri>
</AccountUri>
</Data>
<ErrorCode>2</ErrorCode>
<ErrorDescription>sample string 3</ErrorDescription>
<Meta>sample string 4</Meta>
<Success>true</Success>
</PBNBReturnOfArrayOfAccountUriCA1DLPoZ>
application/bson
Sample:
� Success Data � 0 - AccountID Uri sample string 2 1 - AccountID Uri sample string 2 2 - AccountID Uri sample string 2 ErrorCode ErrorDescription sample string 3 Meta sample string 4