GET api/{module}/Appointment/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

module

string

None.

Body Parameters

None.

Response Information

Resource Description

AppointmentFull
NameDescriptionTypeAdditional information
Configurations

AppointmentConfigurationMain

None.

Persons

Collection of Object

None.

Code

integer

None.

SituationDesc

string

None.

InitialDate

DBDateTime

None.

InitialHour

string

None.

FinalDate

DBDateTime

None.

FinalHour

string

None.

TypeCode

integer

None.

TypeDesc

string

None.

ResponsibleCode

string

None.

Attribute1

string

None.

Attribute2

string

None.

Attribute3

string

None.

Attribute4

string

None.

Title

string

None.

Start

string

None.

End

string

None.

AllDay

boolean

None.

Situation

enumCompromissoSituacao

None.

Color

string

None.

ResponsibleName

string

None.

PersonNames

string

None.

Id

string

None.

UserTableFields

Collection of Object

None.

CreationUser

string

None.

Response Formats

application/json, text/json

Sample:
{
  "configurations": {
    "appointmentCode": 0,
    "remember": true,
    "rememberValue": 3,
    "rememberUnit": 0,
    "rememberUnitDesc": "Minuto(s) antes",
    "screen": true,
    "discreet": true,
    "sonorous": true,
    "email": true,
    "notes": "sample string 8",
    "attribute1": "sample string 9",
    "attribute2": "sample string 10",
    "attribute3": "sample string 11",
    "attribute4": "sample string 12",
    "id": "sample string 14",
    "userTableFields": null,
    "creationUser": "sample string 15"
  },
  "persons": [],
  "code": 1,
  "situationDesc": "Pendente",
  "initialDate": {
    "BinaryData": -8584564661936765808
  },
  "initialHour": "sample string 2",
  "finalDate": {
    "BinaryData": -8584564661936765808
  },
  "finalHour": "sample string 3",
  "typeCode": 4,
  "typeDesc": "COMERCIAL",
  "responsibleCode": null,
  "attribute1": "sample string 6",
  "attribute2": "sample string 7",
  "attribute3": "sample string 8",
  "attribute4": "sample string 9",
  "title": "sample string 10",
  "start": "sample string 11",
  "end": "sample string 12",
  "allDay": true,
  "situation": 0,
  "color": "#149819",
  "responsibleName": "sample string 15",
  "personNames": "sample string 16",
  "id": "sample string 18",
  "userTableFields": null,
  "creationUser": "sample string 19"
}

application/xml, text/xml

Sample:
<AppointmentFull xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Admin">
  <CreationUser xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 19</CreationUser>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 18</Id>
  <UserTableFields i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common" />
  <AllDay>true</AllDay>
  <Color>#149819</Color>
  <End>sample string 12</End>
  <PersonNames>sample string 16</PersonNames>
  <ResponsibleName>sample string 15</ResponsibleName>
  <Situation>Pendente</Situation>
  <Start>sample string 11</Start>
  <Title>sample string 10</Title>
  <Attribute1>sample string 6</Attribute1>
  <Attribute2>sample string 7</Attribute2>
  <Attribute3>sample string 8</Attribute3>
  <Attribute4>sample string 9</Attribute4>
  <Code>1</Code>
  <FinalDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/Avant.DataTypes">
    <BinaryData xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:long" xmlns="">-8584564661936765808</BinaryData>
  </FinalDate>
  <FinalHour>sample string 3</FinalHour>
  <InitialDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/Avant.DataTypes">
    <BinaryData xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:long" xmlns="">-8584564661936765808</BinaryData>
  </InitialDate>
  <InitialHour>sample string 2</InitialHour>
  <ResponsibleCode i:nil="true" />
  <TypeCode>4</TypeCode>
  <Configurations>
    <CreationUser xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 15</CreationUser>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 14</Id>
    <UserTableFields i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common" />
    <AppointmentCode>0</AppointmentCode>
    <Attribute1>sample string 9</Attribute1>
    <Attribute2>sample string 10</Attribute2>
    <Attribute3>sample string 11</Attribute3>
    <Attribute4>sample string 12</Attribute4>
    <Discreet>true</Discreet>
    <Email>true</Email>
    <Notes>sample string 8</Notes>
    <Remember>true</Remember>
    <RememberUnit>Minutos</RememberUnit>
    <RememberValue>3</RememberValue>
    <Screen>true</Screen>
    <Sonorous>true</Sonorous>
  </Configurations>
  <Persons />
</AppointmentFull>