GET api/Representatives
Get a list of available representatives
Request Information
URI Parameters
None.
URI Example
api/Representatives
Body Parameters
None.
Response Information
Resource Description
A wrapper class with the users
Oresto.API.Models.GET.Representatives.RepresentativeData| Name | Description | Type | Additional information |
|---|---|---|---|
| Errors |
Possible errors that were experienced when processing the request |
Collection of string |
None. |
| Representatives |
A list of representatives |
Collection of Oresto.API.Models.GET.Representatives.Representative |
None. |
| RequestInformation |
Additional information about the request |
Oresto.API.Models.Shared.RequestInformation |
None. |
Response Formats
application/json, text/json
Sample:
{
"Representatives": [
{
"Firstname": "sample string 1",
"Lastname": "sample string 2",
"Email": "sample string 3",
"Active": true,
"LanguageCode": "sample string 5",
"Telephone": "sample string 6",
"Fax": "sample string 7",
"Clients": [
{
"ClientNumber": "sample string 1",
"Name": "sample string 2",
"Active": true
},
{
"ClientNumber": "sample string 1",
"Name": "sample string 2",
"Active": true
}
]
},
{
"Firstname": "sample string 1",
"Lastname": "sample string 2",
"Email": "sample string 3",
"Active": true,
"LanguageCode": "sample string 5",
"Telephone": "sample string 6",
"Fax": "sample string 7",
"Clients": [
{
"ClientNumber": "sample string 1",
"Name": "sample string 2",
"Active": true
},
{
"ClientNumber": "sample string 1",
"Name": "sample string 2",
"Active": true
}
]
}
],
"RequestInformation": {
"RequestDuration": 1,
"WholesalerId": 2,
"UserId": 3
},
"Errors": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<RepresentativeData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.GET.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>
<RequestInformation xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<RequestDuration>1</RequestDuration>
<UserId>3</UserId>
<WholesalerId>2</WholesalerId>
</RequestInformation>
<Representatives>
<Representative>
<Active>true</Active>
<Clients>
<Client>
<Active>true</Active>
<ClientNumber>sample string 1</ClientNumber>
<Name>sample string 2</Name>
</Client>
<Client>
<Active>true</Active>
<ClientNumber>sample string 1</ClientNumber>
<Name>sample string 2</Name>
</Client>
</Clients>
<Email>sample string 3</Email>
<Fax>sample string 7</Fax>
<Firstname>sample string 1</Firstname>
<LanguageCode>sample string 5</LanguageCode>
<Lastname>sample string 2</Lastname>
<Telephone>sample string 6</Telephone>
</Representative>
<Representative>
<Active>true</Active>
<Clients>
<Client>
<Active>true</Active>
<ClientNumber>sample string 1</ClientNumber>
<Name>sample string 2</Name>
</Client>
<Client>
<Active>true</Active>
<ClientNumber>sample string 1</ClientNumber>
<Name>sample string 2</Name>
</Client>
</Clients>
<Email>sample string 3</Email>
<Fax>sample string 7</Fax>
<Firstname>sample string 1</Firstname>
<LanguageCode>sample string 5</LanguageCode>
<Lastname>sample string 2</Lastname>
<Telephone>sample string 6</Telephone>
</Representative>
</Representatives>
</RepresentativeData>