Criar bookingAppointment

Artigo
07/18/2022
19 minutos para o fim da leitura

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Crie um novo bookingAppointment para o bookingBusiness especificado.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante)	BookingsAppointment.ReadWrite.All, Bookings.ReadWrite.All, Bookings.Manage.All
Delegado (conta pessoal da Microsoft)	Sem suporte.
Application	BookingsAppointment.ReadWrite.All, Bookings.Read.All

Observação

Se você criar um aplicativo personalizado usando permissões de aplicativo, deverá seguir a validação de regras de negócios.

Solicitação HTTP

POST /bookingBusinesses/{id}/appointments

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{code} do portador. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto bookingAppointment .

Se o número máximo de clientes (maximumAttedeesCount) permitido no serviço for maior que 1:

Verifique se os clientes existem no Calendário de Reserva. Caso contrário, crie usando a operação Criar bookingCustomer .
Passe as IDs de cliente válidas ao criar ou atualizar o compromisso. Se a ID do cliente não for válida, esse cliente não será incluído no objeto de compromisso.

Resposta

Se bem-sucedido, este método retorna um código 201 Created de resposta e um objeto bookingAppointment no corpo da resposta.

Exemplo

Solicitação

Este é um exemplo de solicitação. Esse compromisso não envolve a reserva de membros específicos da equipe.

POST https://graph.microsoft.com/beta/bookingBusinesses/Contosolunchdelivery@contoso.onmicrosoft.com/appointments
Content-type: application/json

{   
    "@odata.type":"#microsoft.graph.bookingAppointment",
    "customerEmailAddress":"jordanm@contoso.com",
    "customerLocation":{
        "@odata.type":"#microsoft.graph.location",
        "address":{
            "@odata.type":"#microsoft.graph.physicalAddress",
            "city":"Buffalo",
            "countryOrRegion":"USA",
            "postalCode":"98052",
            "postOfficeBox":null,
            "state":"NY",
            "street":"123 First Avenue",
            "type@odata.type":"#microsoft.graph.physicalAddressType",
            "type":null
        },
        "coordinates":null,
        "displayName":"Customer",
        "locationEmailAddress":null,
        "locationType@odata.type":"#microsoft.graph.locationType",
        "locationType":null,
        "locationUri":null,
        "uniqueId":null,
        "uniqueIdType@odata.type":"#microsoft.graph.locationUniqueIdType",
        "uniqueIdType":null
    },
    "customerName":"Jordan Miller",
    "customerNotes":"Please be on time.",
    "customerPhone":"213-555-0199",
    "customerTimeZone":"America/Chicago",
    "smsNotificationsEnabled":true,
    "end":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-01T12:30:00.0000000+00:00",
        "timeZone":"UTC"
    },
    "invoiceAmount":10.0,
    "invoiceDate":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-01T12:30:00.0000000+00:00",
        "timeZone":"UTC"
    },
    "invoiceId":"1001",
    "invoiceStatus@odata.type":"#microsoft.graph.bookingInvoiceStatus",
    "invoiceStatus":"open",
    "invoiceUrl":"theInvoiceUrl",
    "isLocationOnline": true,
    "optOutOfCustomerEmail": false,
    "anonymousJoinWebUrl": null,
    "postBuffer": "PT10M",
    "preBuffer": "PT5M",
    "price": 10.0,
    "priceType@odata.type": "#microsoft.graph.bookingPriceType",
    "priceType": "fixedPrice",
    "reminders@odata.type": "#Collection(microsoft.graph.bookingReminder)",
    "reminders": [
        {
            "@odata.type": "#microsoft.graph.bookingReminder",
            "message": "This service is tomorrow",
            "offset": "P1D",
            "recipients@odata.type": "#microsoft.graph.bookingReminderRecipients",
            "recipients": "allAttendees"
        },
        {
            "@odata.type": "#microsoft.graph.bookingReminder",
            "message": "Please be available to enjoy your lunch service.",
            "offset": "PT1H",
            "recipients@odata.type": "#microsoft.graph.bookingReminderRecipients",
            "recipients": "customer"
        },
        {
            "@odata.type": "#microsoft.graph.bookingReminder",
            "message": "Please check traffic for next cater.",
            "offset": "PT2H",
            "recipients@odata.type": "#microsoft.graph.bookingReminderRecipients",
            "recipients": "staff"
        }
    ],
    "serviceId": "57da6774-a087-4d69-b0e6-6fb82c339976",
    "serviceLocation": {
        "@odata.type": "#microsoft.graph.location",
        "address": {
            "@odata.type": "#microsoft.graph.physicalAddress",
            "city": "Buffalo",
            "countryOrRegion": "USA",
            "postalCode": "98052",
            "postOfficeBox": null,
            "state": "NY",
            "street": "123 First Avenue",
            "type@odata.type": "#microsoft.graph.physicalAddressType",
            "type": null
        },
        "coordinates": null,
        "displayName": "Customer location",
        "locationEmailAddress": null,
        "locationType@odata.type": "#microsoft.graph.locationType",
        "locationType": null,
        "locationUri": null,
        "uniqueId": null,
        "uniqueIdType@odata.type": "#microsoft.graph.locationUniqueIdType",
        "uniqueIdType": null
    },
    "serviceName": "Catered bento",
    "serviceNotes": "Customer requires punctual service.",
    "start": {
        "@odata.type": "#microsoft.graph.dateTimeTimeZone",
        "dateTime": "2018-05-01T12:00:00.0000000+00:00",
        "timeZone": "UTC"
    },
    "maximumAttendeesCount": 5,
    "filledAttendeesCount": 1,
    "customers": [
        {
            "@odata.type": "#microsoft.graph.bookingCustomerInformation",
            "customerId": "7ed53fa5-9ef2-4f2f-975b-27447440bc09",
            "name": "Jordan Miller",
            "emailAddress": "jordanm@contoso.com",
            "phone": "213-555-0199",
            "notes": null,
            "location": {
                "@odata.type": "#microsoft.graph.location",
                "displayName": "Customer",
                "locationEmailAddress": null,
                "locationUri": "",
                "locationType": null,
                "uniqueId": null,
                "uniqueIdType": null,
                "address": {
                    "@odata.type": "#microsoft.graph.physicalAddress",
                    "type": "home",
                    "postOfficeBox": "",
                    "street": "",
                    "city": "",
                    "state": "",
                    "countryOrRegion": "",
                    "postalCode": ""
                },
                "coordinates": {
                    "altitude": null,
                    "latitude": null,
                    "longitude": null,
                    "accuracy": null,
                    "altitudeAccuracy": null
                }
            },
            "timeZone":"America/Chicago",
            "customQuestionAnswers": [
                {
                    "questionId": "3bc6fde0-4ad3-445d-ab17-0fc15dba0774",
                    "question": "What is your age",
                    "answerInputType": "text",
                    "answerOptions": [],
                    "isRequired": true,
                    "answer": "25",
                    "selectedOptions": []
                }
            ]
        }
    ]
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var bookingAppointment = new BookingAppointment
{
    CustomerEmailAddress = "jordanm@contoso.com",
    CustomerLocation = new Location
    {
        Address = new PhysicalAddress
        {
            City = "Buffalo",
            CountryOrRegion = "USA",
            PostalCode = "98052",
            PostOfficeBox = null,
            State = "NY",
            Street = "123 First Avenue",
            Type = null,
            AdditionalData = new Dictionary<string, object>()
            {
                {"type@odata.type", "#microsoft.graph.physicalAddressType"}
            }
        },
        Coordinates = null,
        DisplayName = "Customer",
        LocationEmailAddress = null,
        LocationType = null,
        LocationUri = null,
        UniqueId = null,
        UniqueIdType = null,
        AdditionalData = new Dictionary<string, object>()
        {
            {"locationType@odata.type", "#microsoft.graph.locationType"},
            {"uniqueIdType@odata.type", "#microsoft.graph.locationUniqueIdType"}
        }
    },
    CustomerName = "Jordan Miller",
    CustomerNotes = "Please be on time.",
    CustomerPhone = "213-555-0199",
    CustomerTimeZone = "America/Chicago",
    SmsNotificationsEnabled = true,
    End = new DateTimeTimeZone
    {
        DateTime = "2018-05-01T12:30:00+00:00",
        TimeZone = "UTC"
    },
    InvoiceAmount = 10,
    InvoiceDate = new DateTimeTimeZone
    {
        DateTime = "2018-05-01T12:30:00+00:00",
        TimeZone = "UTC"
    },
    InvoiceId = "1001",
    InvoiceStatus = BookingInvoiceStatus.Open,
    InvoiceUrl = "theInvoiceUrl",
    IsLocationOnline = true,
    OptOutOfCustomerEmail = false,
    AnonymousJoinWebUrl = null,
    PostBuffer = new Duration("PT10M"),
    PreBuffer = new Duration("PT5M"),
    Price = 10,
    PriceType = BookingPriceType.FixedPrice,
    Reminders = new List<BookingReminder>()
    {
        new BookingReminder
        {
            Message = "This service is tomorrow",
            Offset = new Duration("P1D"),
            Recipients = BookingReminderRecipients.AllAttendees,
            AdditionalData = new Dictionary<string, object>()
            {
                {"recipients@odata.type", "#microsoft.graph.bookingReminderRecipients"}
            }
        },
        new BookingReminder
        {
            Message = "Please be available to enjoy your lunch service.",
            Offset = new Duration("PT1H"),
            Recipients = BookingReminderRecipients.Customer,
            AdditionalData = new Dictionary<string, object>()
            {
                {"recipients@odata.type", "#microsoft.graph.bookingReminderRecipients"}
            }
        },
        new BookingReminder
        {
            Message = "Please check traffic for next cater.",
            Offset = new Duration("PT2H"),
            Recipients = BookingReminderRecipients.Staff,
            AdditionalData = new Dictionary<string, object>()
            {
                {"recipients@odata.type", "#microsoft.graph.bookingReminderRecipients"}
            }
        }
    },
    ServiceId = "57da6774-a087-4d69-b0e6-6fb82c339976",
    ServiceLocation = new Location
    {
        Address = new PhysicalAddress
        {
            City = "Buffalo",
            CountryOrRegion = "USA",
            PostalCode = "98052",
            PostOfficeBox = null,
            State = "NY",
            Street = "123 First Avenue",
            Type = null,
            AdditionalData = new Dictionary<string, object>()
            {
                {"type@odata.type", "#microsoft.graph.physicalAddressType"}
            }
        },
        Coordinates = null,
        DisplayName = "Customer location",
        LocationEmailAddress = null,
        LocationType = null,
        LocationUri = null,
        UniqueId = null,
        UniqueIdType = null,
        AdditionalData = new Dictionary<string, object>()
        {
            {"locationType@odata.type", "#microsoft.graph.locationType"},
            {"uniqueIdType@odata.type", "#microsoft.graph.locationUniqueIdType"}
        }
    },
    ServiceName = "Catered bento",
    ServiceNotes = "Customer requires punctual service.",
    Start = new DateTimeTimeZone
    {
        DateTime = "2018-05-01T12:00:00+00:00",
        TimeZone = "UTC"
    },
    MaximumAttendeesCount = 5,
    FilledAttendeesCount = 1,
    Customers = new List<BookingCustomerInformationBase>()
    {
        new BookingCustomerInformation
        {
            CustomerId = "7ed53fa5-9ef2-4f2f-975b-27447440bc09",
            Name = "Jordan Miller",
            EmailAddress = "jordanm@contoso.com",
            Phone = "213-555-0199",
            Notes = null,
            Location = new Location
            {
                DisplayName = "Customer",
                LocationEmailAddress = null,
                LocationUri = "",
                LocationType = null,
                UniqueId = null,
                UniqueIdType = null,
                Address = new PhysicalAddress
                {
                    Type = PhysicalAddressType.Home,
                    PostOfficeBox = "",
                    Street = "",
                    City = "",
                    State = "",
                    CountryOrRegion = "",
                    PostalCode = ""
                },
                Coordinates = new OutlookGeoCoordinates
                {
                    Altitude = null,
                    Latitude = null,
                    Longitude = null,
                    Accuracy = null,
                    AltitudeAccuracy = null
                }
            },
            TimeZone = "America/Chicago",
            CustomQuestionAnswers = new List<BookingQuestionAnswer>()
            {
                new BookingQuestionAnswer
                {
                    QuestionId = "3bc6fde0-4ad3-445d-ab17-0fc15dba0774",
                    Question = "What is your age",
                    AnswerInputType = AnswerInputType.Text,
                    AnswerOptions = new List<String>()
                    {
                    },
                    IsRequired = true,
                    Answer = "25",
                    SelectedOptions = new List<String>()
                    {
                    }
                }
            }
        }
    },
    AdditionalData = new Dictionary<string, object>()
    {
        {"invoiceStatus@odata.type", "#microsoft.graph.bookingInvoiceStatus"},
        {"priceType@odata.type", "#microsoft.graph.bookingPriceType"},
        {"reminders@odata.type", "#Collection(microsoft.graph.bookingReminder)"}
    }
};

await graphClient.BookingBusinesses["{bookingBusiness-id}"].Appointments
    .Request()
    .AddAsync(bookingAppointment);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.