GET api/Parcel/GetExternalOperators?authToken={authToken}
Get External Operators
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| authToken |
The Autentication Token |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ServiceResultOfListOfExternalOperatorModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | Collection of ExternalOperatorModel |
None. |
|
| ErrorCode | ServiceErrorCode |
None. |
|
| ErrorMessage | Collection of string |
None. |
|
| Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Result": [
{
"Id": "f9fec320-c184-47ca-84da-6cc697972bd1",
"Name": "sample string 2",
"ExternalCodeMinValue": 3,
"ExternalCodeMaxValue": 4,
"IsActive": true
},
{
"Id": "f9fec320-c184-47ca-84da-6cc697972bd1",
"Name": "sample string 2",
"ExternalCodeMinValue": 3,
"ExternalCodeMaxValue": 4,
"IsActive": true
}
],
"ErrorCode": 0,
"ErrorMessage": [
"sample string 1",
"sample string 2"
],
"Success": true
}
application/xml, text/xml
Sample:
<ServiceResultOfArrayOfExternalOperatorModelEJHQiVcc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.ApiObjects.Results">
<ErrorCode>None</ErrorCode>
<ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ErrorMessage>
<Success>true</Success>
<Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
<d2p1:ExternalOperatorModel>
<d2p1:ExternalCodeMaxValue>4</d2p1:ExternalCodeMaxValue>
<d2p1:ExternalCodeMinValue>3</d2p1:ExternalCodeMinValue>
<d2p1:Id>f9fec320-c184-47ca-84da-6cc697972bd1</d2p1:Id>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:ExternalOperatorModel>
<d2p1:ExternalOperatorModel>
<d2p1:ExternalCodeMaxValue>4</d2p1:ExternalCodeMaxValue>
<d2p1:ExternalCodeMinValue>3</d2p1:ExternalCodeMinValue>
<d2p1:Id>f9fec320-c184-47ca-84da-6cc697972bd1</d2p1:Id>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:ExternalOperatorModel>
</Result>
</ServiceResultOfArrayOfExternalOperatorModelEJHQiVcc>