POST api/Roster?APIKey={APIKey}&ClientId={ClientId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
APIKey | string |
Required |
|
ClientId | string |
Required |
Body Parameters
RosterRequestName | Description | Type | Additional information |
---|---|---|---|
Roster | Roster |
None. |
Request Formats
application/json, text/json
Sample:
{ "Roster": { "Id": "92307b11-21b2-43ba-b7ae-4ea5b3ac6f70", "Code": "sample string 2", "GroupCode": "sample string 3", "GroupId": "9c933131-d487-4816-a3ca-cbaeac88cfe3", "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>9c933131-d487-4816-a3ca-cbaeac88cfe3</GroupId> <Id>92307b11-21b2-43ba-b7ae-4ea5b3ac6f70</Id> <Name>sample string 5</Name> <Sequence>7</Sequence> </Roster> </RosterRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
APIResponseName | Description | Type | Additional information |
---|---|---|---|
Status | Status |
None. |
|
Id | globally unique identifier |
None. |
|
Description | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Status": 0, "Id": "18be3cad-b595-4886-a6b3-8a1c69b63a4d", "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>18be3cad-b595-4886-a6b3-8a1c69b63a4d</Id> <Status>Success</Status> </APIResponse>