PATCH api/platform/providers/{providerId}/contacts/{contactId}?rqUID={rqUID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| providerId | integer |
Required |
|
| contactId | integer |
Required |
|
| rqUID | string |
None. |
Body Parameters
RestContactMixRequestDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
String length: inclusive between 0 and 50 |
|
| Phone | string |
String length: inclusive between 0 and 20 |
|
| string |
Email format String length: inclusive between 0 and 255 |
||
| AuthorizationsEnabled | boolean |
None. |
|
| AuthorizationsMain | boolean |
None. |
|
| PurchasesEnabled | boolean |
None. |
|
| PurchasesMain | boolean |
None. |
|
| OrdersEnabled | boolean |
None. |
|
| OrdersMain | boolean |
None. |
|
| ClaimsEnabled | boolean |
None. |
|
| ClaimsMain | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Phone": "sample string 2",
"Mail": "sample string 3",
"AuthorizationsEnabled": true,
"AuthorizationsMain": true,
"PurchasesEnabled": true,
"PurchasesMain": true,
"OrdersEnabled": true,
"OrdersMain": true,
"ClaimsEnabled": true,
"ClaimsMain": true
}
application/xml, text/xml
Sample:
<RestContactMixRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Platform"> <AuthorizationsEnabled>true</AuthorizationsEnabled> <AuthorizationsMain>true</AuthorizationsMain> <ClaimsEnabled>true</ClaimsEnabled> <ClaimsMain>true</ClaimsMain> <Mail>sample string 3</Mail> <Name>sample string 1</Name> <OrdersEnabled>true</OrdersEnabled> <OrdersMain>true</OrdersMain> <Phone>sample string 2</Phone> <PurchasesEnabled>true</PurchasesEnabled> <PurchasesMain>true</PurchasesMain> </RestContactMixRequestDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RestElementResponseDTOOfRestFullContactDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Element | RestFullContactDTO |
None. |
|
| RqUID | string |
None. |
|
| Code | string |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Element": {
"Id": 1,
"AuthorizationsEnabled": true,
"AuthorizationsMain": true,
"PurchasesEnabled": true,
"PurchasesMain": true,
"OrdersEnabled": true,
"OrdersMain": true,
"ClaimsEnabled": true,
"ClaimsMain": true,
"Name": "sample string 10",
"Phone": "sample string 11",
"Mail": "sample string 12"
},
"RqUID": "sample string 1",
"Code": "sample string 2",
"Message": "sample string 3"
}
application/xml, text/xml
Sample:
<RestElementResponseDTOOfRestFullContactDTOMGEbpewl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">
<Code>sample string 2</Code>
<Message>sample string 3</Message>
<RqUID>sample string 1</RqUID>
<Element xmlns:d2p1="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Platform">
<Mail>sample string 12</Mail>
<Name>sample string 10</Name>
<Phone>sample string 11</Phone>
<d2p1:AuthorizationsEnabled>true</d2p1:AuthorizationsEnabled>
<d2p1:AuthorizationsMain>true</d2p1:AuthorizationsMain>
<d2p1:ClaimsEnabled>true</d2p1:ClaimsEnabled>
<d2p1:ClaimsMain>true</d2p1:ClaimsMain>
<d2p1:Id>1</d2p1:Id>
<d2p1:OrdersEnabled>true</d2p1:OrdersEnabled>
<d2p1:OrdersMain>true</d2p1:OrdersMain>
<d2p1:PurchasesEnabled>true</d2p1:PurchasesEnabled>
<d2p1:PurchasesMain>true</d2p1:PurchasesMain>
</Element>
</RestElementResponseDTOOfRestFullContactDTOMGEbpewl>