GET api/RosterMember?APIKey={APIKey}&ClientId={ClientId}&CustomColumns={CustomColumns}&RosterMemberId={RosterMemberId}&ContactNumber={ContactNumber}&AccountNumber={AccountNumber}

Request Information

URI Parameters

Name	Type	Additional information
APIKey	string	Required
ClientId	string	Required
CustomColumns	string	Default value is
RosterMemberId	globally unique identifier	None.
ContactNumber	string	Default value is
AccountNumber	string	Default value is

Body Parameters

None.

Response Information

Resource Description

RosterMemberRequest

Name	Description	Type	Additional information
RosterMember		Collection of RosterMember	None.

Response Formats

application/json, text/json

Sample:

{
  "RosterMember": [
    {
      "Id": "3ab38498-ba8d-416a-b4d8-8bc0a23cbfc0",
      "Code": "sample string 2",
      "Member": {
        "Type": "sample string 1",
        "Id": "59e438c6-c110-4fa2-858a-50538d141a3f",
        "Number": "sample string 3",
        "Name": "sample string 4"
      },
      "Comments": "sample string 3",
      "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"
          }
        ]
      }
    },
    {
      "Id": "3ab38498-ba8d-416a-b4d8-8bc0a23cbfc0",
      "Code": "sample string 2",
      "Member": {
        "Type": "sample string 1",
        "Id": "59e438c6-c110-4fa2-858a-50538d141a3f",
        "Number": "sample string 3",
        "Name": "sample string 4"
      },
      "Comments": "sample string 3",
      "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:

<RosterMemberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.RosterMember">
  <RosterMember>
    <RosterMember>
      <Code>sample string 2</Code>
      <Comments>sample string 3</Comments>
      <Custom>
        <Attribute xmlns:d5p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity">
          <d5p1:Attribute>
            <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Type>text</d5p1:Type>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:Attribute>
          <d5p1:Attribute>
            <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Type>text</d5p1:Type>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:Attribute>
        </Attribute>
      </Custom>
      <Id>3ab38498-ba8d-416a-b4d8-8bc0a23cbfc0</Id>
      <Member>
        <Id>59e438c6-c110-4fa2-858a-50538d141a3f</Id>
        <Name>sample string 4</Name>
        <Number>sample string 3</Number>
        <Type>sample string 1</Type>
      </Member>
    </RosterMember>
    <RosterMember>
      <Code>sample string 2</Code>
      <Comments>sample string 3</Comments>
      <Custom>
        <Attribute xmlns:d5p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity">
          <d5p1:Attribute>
            <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Type>text</d5p1:Type>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:Attribute>
          <d5p1:Attribute>
            <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Type>text</d5p1:Type>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:Attribute>
        </Attribute>
      </Custom>
      <Id>3ab38498-ba8d-416a-b4d8-8bc0a23cbfc0</Id>
      <Member>
        <Id>59e438c6-c110-4fa2-858a-50538d141a3f</Id>
        <Name>sample string 4</Name>
        <Number>sample string 3</Number>
        <Type>sample string 1</Type>
      </Member>
    </RosterMember>
  </RosterMember>
</RosterMemberRequest>