GET Spectra/AgentRoster

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Description	Type	Additional information
Offices		Collection of Office	None.

Response Formats

application/json, text/json

Sample:

{
  "Offices": [
    {
      "pk_Office": 1,
      "OfficeCode": "sample string 2",
      "OfficeName": "sample string 3",
      "Active": true,
      "Agents": [
        {
          "pk_AppUser": 1,
          "Username": "sample string 2",
          "SecurityLevel": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "EmailAddress": "sample string 6",
          "Active": true
        },
        {
          "pk_AppUser": 1,
          "Username": "sample string 2",
          "SecurityLevel": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "EmailAddress": "sample string 6",
          "Active": true
        }
      ]
    },
    {
      "pk_Office": 1,
      "OfficeCode": "sample string 2",
      "OfficeName": "sample string 3",
      "Active": true,
      "Agents": [
        {
          "pk_AppUser": 1,
          "Username": "sample string 2",
          "SecurityLevel": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "EmailAddress": "sample string 6",
          "Active": true
        },
        {
          "pk_AppUser": 1,
          "Username": "sample string 2",
          "SecurityLevel": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "EmailAddress": "sample string 6",
          "Active": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<SpectraModel.AgentRoster xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <Offices>
    <SpectraModel.AgentRoster.Office>
      <Active>true</Active>
      <Agents>
        <SpectraModel.AgentRoster.Agent>
          <Active>true</Active>
          <EmailAddress>sample string 6</EmailAddress>
          <FirstName>sample string 4</FirstName>
          <LastName>sample string 5</LastName>
          <SecurityLevel>sample string 3</SecurityLevel>
          <Username>sample string 2</Username>
          <pk_AppUser>1</pk_AppUser>
        </SpectraModel.AgentRoster.Agent>
        <SpectraModel.AgentRoster.Agent>
          <Active>true</Active>
          <EmailAddress>sample string 6</EmailAddress>
          <FirstName>sample string 4</FirstName>
          <LastName>sample string 5</LastName>
          <SecurityLevel>sample string 3</SecurityLevel>
          <Username>sample string 2</Username>
          <pk_AppUser>1</pk_AppUser>
        </SpectraModel.AgentRoster.Agent>
      </Agents>
      <OfficeCode>sample string 2</OfficeCode>
      <OfficeName>sample string 3</OfficeName>
      <pk_Office>1</pk_Office>
    </SpectraModel.AgentRoster.Office>
    <SpectraModel.AgentRoster.Office>
      <Active>true</Active>
      <Agents>
        <SpectraModel.AgentRoster.Agent>
          <Active>true</Active>
          <EmailAddress>sample string 6</EmailAddress>
          <FirstName>sample string 4</FirstName>
          <LastName>sample string 5</LastName>
          <SecurityLevel>sample string 3</SecurityLevel>
          <Username>sample string 2</Username>
          <pk_AppUser>1</pk_AppUser>
        </SpectraModel.AgentRoster.Agent>
        <SpectraModel.AgentRoster.Agent>
          <Active>true</Active>
          <EmailAddress>sample string 6</EmailAddress>
          <FirstName>sample string 4</FirstName>
          <LastName>sample string 5</LastName>
          <SecurityLevel>sample string 3</SecurityLevel>
          <Username>sample string 2</Username>
          <pk_AppUser>1</pk_AppUser>
        </SpectraModel.AgentRoster.Agent>
      </Agents>
      <OfficeCode>sample string 2</OfficeCode>
      <OfficeName>sample string 3</OfficeName>
      <pk_Office>1</pk_Office>
    </SpectraModel.AgentRoster.Office>
  </Offices>
</SpectraModel.AgentRoster>