GET api/{module}/Conveyor/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
|
| module | string |
None. |
Body Parameters
None.
Response Information
Resource Description
ConveyorMain| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
String length: inclusive between 0 and 120 |
|
| Situation | EPersonSituation |
None. |
|
| SituationDesc | string |
None. |
|
| Type | ETypePerson |
None. |
|
| TypeDescription | string |
None. |
|
| LegalId | string |
String length: inclusive between 0 and 20 |
|
| StateId | string |
String length: inclusive between 0 and 20 |
|
| MunicipalId | string |
String length: inclusive between 0 and 20 |
|
| Telephone | string |
String length: inclusive between 0 and 20 |
|
| Cellphone | string |
String length: inclusive between 0 and 20 |
|
| string |
String length: inclusive between 0 and 120 |
||
| Id | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"name": "sample string 1",
"situation": 0,
"situationDesc": "Ativo",
"type": 0,
"typeDescription": "Jurídica",
"legalId": "sample string 2",
"stateId": "sample string 3",
"municipalId": "sample string 4",
"telephone": "sample string 5",
"cellphone": "sample string 6",
"email": "sample string 7",
"id": "sample string 8"
}
application/xml, text/xml
Sample:
<ConveyorMain xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Admin"> <Id xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 8</Id> <Cellphone>sample string 6</Cellphone> <Email>sample string 7</Email> <LegalId>sample string 2</LegalId> <MunicipalId>sample string 4</MunicipalId> <Name>sample string 1</Name> <Situation>Active</Situation> <StateId>sample string 3</StateId> <Telephone>sample string 5</Telephone> <Type>LegalEntity</Type> </ConveyorMain>