PUT api/Roster?APIKey={APIKey}&ClientId={ClientId}

Request Information

URI Parameters

Name	Description	Type	Additional information
APIKey		string	Required
ClientId		string	Required

Body Parameters

RosterRequest

Name	Description	Type	Additional information
Roster		Roster	None.

Request Formats

application/json, text/json

Sample:

{
  "Roster": {
    "Id": "f463badc-b64a-40f8-bda7-89980e61cb6e",
    "Code": "sample string 2",
    "GroupCode": "sample string 3",
    "GroupId": "5448d2ea-0793-4001-9b39-891c36b550d9",
    "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>5448d2ea-0793-4001-9b39-891c36b550d9</GroupId>
    <Id>f463badc-b64a-40f8-bda7-89980e61cb6e</Id>
    <Name>sample string 5</Name>
    <Sequence>7</Sequence>
  </Roster>
</RosterRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResponse

Name	Type	Additional information
Status	Status	None.
Id	globally unique identifier	None.
Description	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "Id": "cd71faff-a3ce-4a93-9a72-1525140b01a4",
  "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>cd71faff-a3ce-4a93-9a72-1525140b01a4</Id>
  <Status>Success</Status>
</APIResponse>