GET api/Roster?APIKey={APIKey}&ClientId={ClientId}&RosterCode={RosterCode}&CustomColumns={CustomColumns}

Request Information

URI Parameters

Name	Type	Additional information
APIKey	string	Required
ClientId	string	Required
RosterCode	string	Required
CustomColumns	string	Default value is

Body Parameters

None.

Response Information

Resource Description

RosterRequest

Name	Description	Type	Additional information
Roster		Roster	None.

Response Formats

application/json, text/json

Sample:

{
  "Roster": {
    "Id": "c4dd2823-f1f0-4f9d-a667-b9bcb1534447",
    "Code": "sample string 2",
    "GroupCode": "sample string 3",
    "GroupId": "c5c0a8a1-96bd-4c43-b28f-85e14c3df362",
    "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>c5c0a8a1-96bd-4c43-b28f-85e14c3df362</GroupId>
    <Id>c4dd2823-f1f0-4f9d-a667-b9bcb1534447</Id>
    <Name>sample string 5</Name>
    <Sequence>7</Sequence>
  </Roster>
</RosterRequest>