POST api/RosterMember?APIKey={APIKey}&ClientId={ClientId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
APIKey

string

Required

ClientId

string

Required

Body Parameters

RosterMemberRequest
NameDescriptionTypeAdditional information
RosterMember

Collection of RosterMember

None.

Request Formats

application/json, text/json

Sample:
{
  "RosterMember": [
    {
      "Id": "6c933151-2466-496f-b300-5180438a655e",
      "Code": "sample string 2",
      "Member": {
        "Type": "sample string 1",
        "Id": "a13258c2-e134-40eb-8253-105ae06759ac",
        "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": "6c933151-2466-496f-b300-5180438a655e",
      "Code": "sample string 2",
      "Member": {
        "Type": "sample string 1",
        "Id": "a13258c2-e134-40eb-8253-105ae06759ac",
        "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>6c933151-2466-496f-b300-5180438a655e</Id>
      <Member>
        <Id>a13258c2-e134-40eb-8253-105ae06759ac</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>6c933151-2466-496f-b300-5180438a655e</Id>
      <Member>
        <Id>a13258c2-e134-40eb-8253-105ae06759ac</Id>
        <Name>sample string 4</Name>
        <Number>sample string 3</Number>
        <Type>sample string 1</Type>
      </Member>
    </RosterMember>
  </RosterMember>
</RosterMemberRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResponse
NameDescriptionTypeAdditional information
Status

Status

None.

Id

globally unique identifier

None.

Description

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "Id": "c5a57053-9c00-48c3-89fa-53ff6791531a",
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:
<APIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Response">
  <Description>sample string 2</Description>
  <Id>c5a57053-9c00-48c3-89fa-53ff6791531a</Id>
  <Status>Success</Status>
</APIResponse>