POST api/Representatives/LinkRepresentativeToClients

Create a link between a Representative and multiple Clients

Request Information

URI Parameters

None.

URI Example

api/Representatives/LinkRepresentativeToClients

Body Parameters

RepresentativeToClients data

Oresto.API.Models.POST.Representatives.RepresentativeToClients
NameDescriptionTypeAdditional information
ClientNumbers

The numbers of the clients defined by the wholesaler

Collection of Oresto.API.Models.POST.Representatives.User

Required

EmailRepresentative

The e-mail address of the representative (Login)

string

Required

Max length: 100

Request Formats

application/json, text/json

Sample:
{
  "EmailRepresentative": "sample string 1",
  "ClientNumbers": [
    {
      "ClientNumber": "sample string 1"
    },
    {
      "ClientNumber": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:
<RepresentativeToClients xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.POST.Representatives">
  <ClientNumbers>
    <User>
      <ClientNumber>sample string 1</ClientNumber>
    </User>
    <User>
      <ClientNumber>sample string 1</ClientNumber>
    </User>
  </ClientNumbers>
  <EmailRepresentative>sample string 1</EmailRepresentative>
</RepresentativeToClients>

application/x-www-form-urlencoded

Sample:
EmailRepresentative=value&ClientNumbers=value

Response Information

Resource Description

A wrapper class with the linked information

Oresto.API.Models.POST.Representatives.RepresentativeToClientsData
NameDescriptionTypeAdditional 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:
<RepresentativeToClientsData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.POST.Representatives">
  <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>
</RepresentativeToClientsData>