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

Return a specific agent within this account

Request Information

Parameters

NameDescriptionAdditional information
accId

Define this parameter in the request URI.

agtId
No documentation available.

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"
  },
  "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},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

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

application/bson

Sample:
�SuccessDataSIDAccountIDNamesample 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