GET v1/core/accounts/{accId}/agents?expand={expand}

Return the list of agents for this account

Request Information

Parameters

Name	Description	Additional information
accId		Define this parameter in the request URI.
expand	No documentation available.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": [
    {
      "ID": 1,
      "AccountID": 2,
      "Name": "sample string 3",
      "Routes": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "Info": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "Services": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "CName": "sample string 6",
      "Status": "Activation|EnabledDown|EnabledUp|Disabled|Deleted"
    },
    {
      "ID": 1,
      "AccountID": 2,
      "Name": "sample string 3",
      "Routes": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "Info": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "Services": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "CName": "sample string 6",
      "Status": "Activation|EnabledDown|EnabledUp|Disabled|Deleted"
    },
    {
      "ID": 1,
      "AccountID": 2,
      "Name": "sample string 3",
      "Routes": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "Info": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "Services": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "CName": "sample string 6",
      "Status": "Activation|EnabledDown|EnabledUp|Disabled|Deleted"
    }
  ],
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:

{"Success":true,"Data":[{"ID":1,"AccountID":2,"Name":"sample string 3","Routes":["sample string 1","sample string 2","sample string 3"],"Info":["sample string 1","sample string 2","sample string 3"],"Services":["sample string 1","sample string 2","sample string 3"],"CName":"sample string 6","Status":0},{"ID":1,"AccountID":2,"Name":"sample string 3","Routes":["sample string 1","sample string 2","sample string 3"],"Info":["sample string 1","sample string 2","sample string 3"],"Services":["sample string 1","sample string 2","sample string 3"],"CName":"sample string 6","Status":0},{"ID":1,"AccountID":2,"Name":"sample string 3","Routes":["sample string 1","sample string 2","sample string 3"],"Info":["sample string 1","sample string 2","sample string 3"],"Services":["sample string 1","sample string 2","sample string 3"],"CName":"sample string 6","Status":0}],"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:

<PBNBReturnOfArrayOfAgentCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <Agent>
      <AccountID>2</AccountID>
      <CName>sample string 6</CName>
      <ID>1</ID>
      <Info xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Info>
      <Name>sample string 3</Name>
      <Routes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Routes>
      <Services xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Services>
      <Status>Activation|EnabledDown|EnabledUp|Disabled|Deleted</Status>
    </Agent>
    <Agent>
      <AccountID>2</AccountID>
      <CName>sample string 6</CName>
      <ID>1</ID>
      <Info xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Info>
      <Name>sample string 3</Name>
      <Routes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Routes>
      <Services xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Services>
      <Status>Activation|EnabledDown|EnabledUp|Disabled|Deleted</Status>
    </Agent>
    <Agent>
      <AccountID>2</AccountID>
      <CName>sample string 6</CName>
      <ID>1</ID>
      <Info xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Info>
      <Name>sample string 3</Name>
      <Routes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Routes>
      <Services xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </Services>
      <Status>Activation|EnabledDown|EnabledUp|Disabled|Deleted</Status>
    </Agent>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfArrayOfAgentCA1DLPoZ>

application/bson

Sample:

kSuccessData0SIDAccountIDNamesample string 3RoutesJ0sample string 11sample string 22sample string 3InfoJ0sample string 11sample string 22sample string 3ServicesJ0sample string 11sample string 22sample string 3CNamesample string 6Status1SIDAccountIDNamesample string 3RoutesJ0sample string 11sample string 22sample string 3InfoJ0sample string 11sample string 22sample string 3ServicesJ0sample string 11sample string 22sample string 3CNamesample string 6Status2SIDAccountIDNamesample string 3RoutesJ0sample string 11sample string 22sample string 3InfoJ0sample string 11sample string 22sample string 3ServicesJ0sample string 11sample string 22sample string 3CNamesample string 6StatusErrorCodeErrorDescriptionsample string 3Metasample string 4