POST api/RosterMember?APIKey={APIKey}&ClientId={ClientId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
APIKey | string |
Required |
|
ClientId | string |
Required |
Body Parameters
RosterMemberRequestName | Description | Type | Additional information |
---|---|---|---|
RosterMember | Collection of RosterMember |
None. |
Request Formats
application/json, text/json
Sample:
{ "RosterMember": [ { "Id": "abbdb9b8-e086-4188-89f8-f0f13ccdfa4d", "Code": "sample string 2", "Member": { "Type": "sample string 1", "Id": "3e6b712c-cbd9-4819-aaa8-8f161f29ec83", "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": "abbdb9b8-e086-4188-89f8-f0f13ccdfa4d", "Code": "sample string 2", "Member": { "Type": "sample string 1", "Id": "3e6b712c-cbd9-4819-aaa8-8f161f29ec83", "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>abbdb9b8-e086-4188-89f8-f0f13ccdfa4d</Id> <Member> <Id>3e6b712c-cbd9-4819-aaa8-8f161f29ec83</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>abbdb9b8-e086-4188-89f8-f0f13ccdfa4d</Id> <Member> <Id>3e6b712c-cbd9-4819-aaa8-8f161f29ec83</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
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": "c7dbe7e9-396b-4b92-bf95-8592735c640f", "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>c7dbe7e9-396b-4b92-bf95-8592735c640f</Id> <Status>Success</Status> </APIResponse>