Atualizar bookingAppointment

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.

Atualize as propriedades de um objeto bookingAppointment no 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

PATCH /bookingBusinesses/{id}/appointments/{id}

Cabeçalhos de solicitação opcionais

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

Corpo da solicitação

No corpo da solicitação, forneça apenas os valores das propriedades que devem ser atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação manterão seus valores anteriores ou serão recalculadas com base nas alterações em outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade	Tipo	Descrição
customerEmailAddress	Cadeia de caracteres	O endereço SMTP do bookingCustomer que está reservando o compromisso.
customerId	String	A ID do bookingCustomer para este compromisso. Se nenhuma ID for especificada quando um compromisso for criado, um novo objeto bookingCustomer será criado. Depois de definido, você deve considerar a customerId imutável.
customerLocation	location	Representa informações de localização para o bookingCustomer que está reservando o compromisso.
Customername	Cadeia de caracteres	O nome do cliente.
customerNotes	String	Observações do cliente associadas a este compromisso. Você só pode obter o valor ao ler este bookingAppointment por sua ID. Você só pode definir essa propriedade ao criar inicialmente um compromisso com um novo cliente. Depois desse ponto, o valor é calculado do cliente representado por customerId.
customerPhone	String	O número de telefone do cliente.
Clientes	coleção bookingCustomerInformation	Ele lista as propriedades do cliente para um compromisso. Um compromisso conterá uma lista de informações do cliente e cada unidade indicará as propriedades de um cliente que faz parte desse compromisso. Opcional.
customerTimeZone	String	O fuso horário do cliente. Para obter uma lista de valores possíveis, consulte dateTimeTimeZone.
duração	Duração	O comprimento do compromisso, indicado no formato ISO8601 .
end	dateTimeTimeZone	A data, a hora e o fuso horário em que o compromisso termina.
invoiceAmount	Duplo	O valor cobrado na fatura.
invoiceDate	dateTimeTimeZone	A data, a hora e o fuso horário da fatura para este compromisso.
invoiceId	Cadeia de caracteres	A ID da fatura.
invoiceStatus	string	O status da fatura. Os possíveis valores são: draft, reviewing, open, canceled, paid, corrective.
invoiceUrl	String	A URL da fatura em Microsoft Bookings.
filledAttendeesCount	Int32	O número atual de clientes no compromisso. Obrigatório.
isLocationOnline	Boolean	True indica que o compromisso será mantido online. O valor padrão é falso.
maximumAttendeesCount	Int32	O número máximo de clientes permitidos no compromisso. Obrigatório.
optOutOfCustomerEmail	Boolean	True indica que o bookingCustomer para este compromisso não deseja receber uma confirmação para este compromisso.
Postbuffer	Duração	A quantidade de tempo a ser reservado após o término do compromisso, para limpeza, como exemplo. O valor é expresso no formato ISO8601 .
Prebuffer	Duração	A quantidade de tempo a ser reservado antes do início do compromisso, para preparação, como exemplo. O valor é expresso no formato ISO8601 .
Preço	Duplo	O preço normal de um compromisso para o bookingService especificado.
priceType	bookingPriceType	Uma configuração para fornecer flexibilidade para a estrutura de preços dos serviços. Os valores possíveis são: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet, unknownFutureValue.
Lembretes	coleção bookingReminder	A coleção de lembretes de clientes enviados para este compromisso. O valor dessa propriedade está disponível somente ao ler este bookingAppointment por sua ID.
selfServiceAppointmentId	String	Uma ID de acompanhamento adicional para o compromisso, se o compromisso tiver sido criado diretamente pelo cliente na página de agendamento, em vez de um membro da equipe em nome do cliente.
serviceId	Cadeia de caracteres	A ID do bookingService associado a este compromisso.
serviceLocation	location	O local onde o serviço é entregue.
serviceName	Cadeia de caracteres	O nome do bookingService associado a este compromisso. Essa propriedade é opcional ao criar um novo compromisso. Se não for especificado, ele será calculado do serviço associado ao compromisso pela propriedade serviceId .
serviceNotes	String	Anotações de um bookingStaffMember. O valor dessa propriedade está disponível somente ao ler este bookingAppointment por sua ID.
smsNotificationsEnabled	Booliano	True indica que as notificações por SMS serão enviadas aos clientes para o compromisso. O valor padrão é falso.
staffMemberIds	String collection	A ID de cada bookingStaffMember agendado neste compromisso.
iniciar	dateTimeTimeZone	A data, a hora e o fuso horário em que o compromisso começa.

Observação

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 tiver êxito, este método retornará um código de resposta 204 No Content. Ele não retorna nada no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir altera a data do serviço por dia e atualiza a data da fatura.

HTTP

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

{
    "@odata.type":"#microsoft.graph.bookingAppointment",
    "end":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",
        "timeZone":"UTC"
    },
    "invoiceDate":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",
        "timeZone":"UTC"
    },
    "start":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:00:00.0000000+00:00",
        "timeZone":"UTC"
    }
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var bookingAppointment = new BookingAppointment
{
    End = new DateTimeTimeZone
    {
        DateTime = "2018-05-06T12:30:00+00:00",
        TimeZone = "UTC"
    },
    InvoiceDate = new DateTimeTimeZone
    {
        DateTime = "2018-05-06T12:30:00+00:00",
        TimeZone = "UTC"
    },
    Start = new DateTimeTimeZone
    {
        DateTime = "2018-05-06T12:00:00+00:00",
        TimeZone = "UTC"
    }
};

await graphClient.BookingBusinesses["{bookingBusiness-id}"].Appointments["{bookingAppointment-id}"]
    .Request()
    .UpdateAsync(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.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const bookingAppointment = {
    '@odata.type':'#microsoft.graph.bookingAppointment',
    end: {
        '@odata.type':'#microsoft.graph.dateTimeTimeZone',
        dateTime: '2018-05-06T12:30:00.0000000+00:00',
        timeZone: 'UTC'
    },
    invoiceDate: {
        '@odata.type':'#microsoft.graph.dateTimeTimeZone',
        dateTime: '2018-05-06T12:30:00.0000000+00:00',
        timeZone: 'UTC'
    },
    start: {
        '@odata.type':'#microsoft.graph.dateTimeTimeZone',
        dateTime: '2018-05-06T12:00:00.0000000+00:00',
        timeZone: 'UTC'
    }
};

await client.api('/bookingBusinesses/Contosolunchdelivery@contoso.onmicrosoft.com/appointments/AAMkADKnAAA=')
    .version('beta')
    .update(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.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/bookingBusinesses/Contosolunchdelivery@contoso.onmicrosoft.com/appointments/AAMkADKnAAA="]]];
[urlRequest setHTTPMethod:@"PATCH"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphBookingAppointment *bookingAppointment = [[MSGraphBookingAppointment alloc] init];
MSGraphDateTimeTimeZone *end = [[MSGraphDateTimeTimeZone alloc] init];
[end setDateTime: "2018-05-06T12:30:00+00:00"];
[end setTimeZone:@"UTC"];
[bookingAppointment setEnd:end];
MSGraphDateTimeTimeZone *invoiceDate = [[MSGraphDateTimeTimeZone alloc] init];
[invoiceDate setDateTime: "2018-05-06T12:30:00+00:00"];
[invoiceDate setTimeZone:@"UTC"];
[bookingAppointment setInvoiceDate:invoiceDate];
MSGraphDateTimeTimeZone *start = [[MSGraphDateTimeTimeZone alloc] init];
[start setDateTime: "2018-05-06T12:00:00+00:00"];
[start setTimeZone:@"UTC"];
[bookingAppointment setStart:start];

NSError *error;
NSData *bookingAppointmentData = [bookingAppointment getSerializedDataWithError:&error];
[urlRequest setHTTPBody:bookingAppointmentData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

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.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

BookingAppointment bookingAppointment = new BookingAppointment();
DateTimeTimeZone end = new DateTimeTimeZone();
end.dateTime = "2018-05-06T12:30:00+00:00";
end.timeZone = "UTC";
bookingAppointment.end = end;
DateTimeTimeZone invoiceDate = new DateTimeTimeZone();
invoiceDate.dateTime = "2018-05-06T12:30:00+00:00";
invoiceDate.timeZone = "UTC";
bookingAppointment.invoiceDate = invoiceDate;
DateTimeTimeZone start = new DateTimeTimeZone();
start.dateTime = "2018-05-06T12:00:00+00:00";
start.timeZone = "UTC";
bookingAppointment.start = start;

graphClient.bookingBusinesses("Contosolunchdelivery@contoso.onmicrosoft.com").appointments("AAMkADKnAAA=")
    .buildRequest()
    .patch(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.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewBookingAppointment()
end := msgraphsdk.NewDateTimeTimeZone()
requestBody.SetEnd(end)
dateTime := "2018-05-06T12:30:00.0000000+00:00"
end.SetDateTime(&dateTime)
timeZone := "UTC"
end.SetTimeZone(&timeZone)
end.SetAdditionalData(map[string]interface{}{
    "@odata.type": "#microsoft.graph.dateTimeTimeZone",
}
invoiceDate := msgraphsdk.NewDateTimeTimeZone()
requestBody.SetInvoiceDate(invoiceDate)
dateTime := "2018-05-06T12:30:00.0000000+00:00"
invoiceDate.SetDateTime(&dateTime)
timeZone := "UTC"
invoiceDate.SetTimeZone(&timeZone)
invoiceDate.SetAdditionalData(map[string]interface{}{
    "@odata.type": "#microsoft.graph.dateTimeTimeZone",
}
start := msgraphsdk.NewDateTimeTimeZone()
requestBody.SetStart(start)
dateTime := "2018-05-06T12:00:00.0000000+00:00"
start.SetDateTime(&dateTime)
timeZone := "UTC"
start.SetTimeZone(&timeZone)
start.SetAdditionalData(map[string]interface{}{
    "@odata.type": "#microsoft.graph.dateTimeTimeZone",
}
requestBody.SetAdditionalData(map[string]interface{}{
    "@odata.type": "#microsoft.graph.bookingAppointment",
}
bookingBusinessId := "bookingBusiness-id"
bookingAppointmentId := "bookingAppointment-id"
graphClient.BookingBusinessesById(&bookingBusinessId).AppointmentsById(&bookingAppointmentId).Patch(requestBody)

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.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.Bookings

$params = @{
    "@odata.type" = "#microsoft.graph.bookingAppointment"
    End = @{
        "@odata.type" = "#microsoft.graph.dateTimeTimeZone"
        DateTime = "2018-05-06T12:30:00.0000000+00:00"
        TimeZone = "UTC"
    }
    InvoiceDate = @{
        "@odata.type" = "#microsoft.graph.dateTimeTimeZone"
        DateTime = "2018-05-06T12:30:00.0000000+00:00"
        TimeZone = "UTC"
    }
    Start = @{
        "@odata.type" = "#microsoft.graph.dateTimeTimeZone"
        DateTime = "2018-05-06T12:00:00.0000000+00:00"
        TimeZone = "UTC"
    }
}

Update-MgBookingBusinessAppointment -BookingBusinessId $bookingBusinessId -BookingAppointmentId $bookingAppointmentId -BodyParameter $params

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.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Resposta

Este é um exemplo de resposta.

HTTP/1.1 204 No Content