POST api/RosterMember

Request Information

URI Parameters

None.

Body Parameters

RosterMemberRequest
NameDescriptionTypeAdditional information
RosterMember

RosterMember

None.

Request Formats

application/json, text/json

Sample:
{
  "RosterMember": {
    "Id": "5586af62-0eea-481d-be21-c463c70838dc",
    "RosterId": "6121463d-ebe2-4e94-99ea-fb91bcf47695",
    "RosterCode": "sample string 3",
    "Member": {
      "Type": "sample string 1",
      "Id": "6722415a-0bb9-4283-927a-723032c8a76d",
      "Number": "sample string 3",
      "Name": "sample string 4"
    },
    "Comments": "sample string 4",
    "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>
    <Comments>sample string 4</Comments>
    <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>
    <Id>5586af62-0eea-481d-be21-c463c70838dc</Id>
    <Member>
      <Id>6722415a-0bb9-4283-927a-723032c8a76d</Id>
      <Name>sample string 4</Name>
      <Number>sample string 3</Number>
      <Type>sample string 1</Type>
    </Member>
    <RosterCode>sample string 3</RosterCode>
    <RosterId>6121463d-ebe2-4e94-99ea-fb91bcf47695</RosterId>
  </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": "38716c22-eb97-4521-8bcc-4467e0e5a502",
  "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>38716c22-eb97-4521-8bcc-4467e0e5a502</Id>
  <Status>Success</Status>
</APIResponse>