POST api/Clients/LinkClientToUsers
Create a link between a Client and multiple Users
Request Information
URI Parameters
None.
URI Example
api/Clients/LinkClientToUsers
Body Parameters
ClientToUsers data
Oresto.API.Models.POST.Clients.ClientToUsers| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientNumber |
The number of the client defined by the wholesaler |
string |
Primary key field Required Max length: 50 |
| EmailUsers |
The e-mail addresses of the users |
Collection of Oresto.API.Models.POST.Clients.User |
Required |
Request Formats
application/json, text/json
Sample:
{
"ClientNumber": "sample string 1",
"EmailUsers": [
{
"Email": "sample string 1"
},
{
"Email": "sample string 1"
}
]
}
application/xml, text/xml
Sample:
<ClientToUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.POST.Clients">
<ClientNumber>sample string 1</ClientNumber>
<EmailUsers>
<User>
<Email>sample string 1</Email>
</User>
<User>
<Email>sample string 1</Email>
</User>
</EmailUsers>
</ClientToUsers>
application/x-www-form-urlencoded
Sample:
ClientNumber=value&EmailUsers=value
Response Information
Resource Description
A wrapper class with the client info
Oresto.API.Models.POST.Clients.ClientToUsersData| Name | Description | Type | Additional information |
|---|---|---|---|
| Errors |
Possible errors that were experienced when processing the request |
Collection of string |
None. |
| ModelStateErrors |
Possible model errors that were experienced when validating the data |
Collection of Oresto.API.Models.Shared.ModelStateError |
None. |
| RequestInformation |
Additional information about the request |
Oresto.API.Models.Shared.RequestInformation |
None. |
Response Formats
application/json, text/json
Sample:
{
"RequestInformation": {
"RequestDuration": 1,
"WholesalerId": 2,
"UserId": 3
},
"ModelStateErrors": [
{
"Key": "sample string 1",
"Message": "sample string 2",
"Exception": "sample string 3"
},
{
"Key": "sample string 1",
"Message": "sample string 2",
"Exception": "sample string 3"
}
],
"Errors": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<ClientToUsersData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.POST.Clients">
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<ModelStateErrors xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<ModelStateError>
<Exception>sample string 3</Exception>
<Key>sample string 1</Key>
<Message>sample string 2</Message>
</ModelStateError>
<ModelStateError>
<Exception>sample string 3</Exception>
<Key>sample string 1</Key>
<Message>sample string 2</Message>
</ModelStateError>
</ModelStateErrors>
<RequestInformation xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<RequestDuration>1</RequestDuration>
<UserId>3</UserId>
<WholesalerId>2</WholesalerId>
</RequestInformation>
</ClientToUsersData>