GET api/Roster?RosterId={RosterId}&RosterCode={RosterCode}&CustomColumns={CustomColumns}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RosterId

globally unique identifier

None.

RosterCode

string

Default value is

CustomColumns

string

Default value is

Body Parameters

None.

Response Information

Resource Description

RosterRequest
NameDescriptionTypeAdditional information
Roster

Roster

None.

Response Formats

application/json, text/json

Sample:
{
  "Roster": {
    "Id": "33d26d08-587d-4eb1-82e3-acebfd1eb1d5",
    "Code": "sample string 2",
    "GroupCode": "sample string 3",
    "GroupId": "3a8512c1-5b7e-4e9e-b308-43a64a88f832",
    "Name": "sample string 5",
    "Description": "sample string 6",
    "Sequence": 7,
    "Custom": {
      "Attribute": [
        {
          "Type": 0,
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3"
        },
        {
          "Type": 0,
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:
<RosterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Roster">
  <Roster>
    <Code>sample string 2</Code>
    <Custom>
      <Attribute xmlns:d4p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity">
        <d4p1:Attribute>
          <d4p1:FormattedValue>sample string 3</d4p1:FormattedValue>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Type>text</d4p1:Type>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:Attribute>
        <d4p1:Attribute>
          <d4p1:FormattedValue>sample string 3</d4p1:FormattedValue>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Type>text</d4p1:Type>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:Attribute>
      </Attribute>
    </Custom>
    <Description>sample string 6</Description>
    <GroupCode>sample string 3</GroupCode>
    <GroupId>3a8512c1-5b7e-4e9e-b308-43a64a88f832</GroupId>
    <Id>33d26d08-587d-4eb1-82e3-acebfd1eb1d5</Id>
    <Name>sample string 5</Name>
    <Sequence>7</Sequence>
  </Roster>
</RosterRequest>