/Reação

Ponto de extremidade da API para consultar dados de reações em qualquer Ação enviada em um grupo.

POST /reaction

POST {endpoint-url}/v1/groups/{groupId}/reaction

Parâmetros de solicitação

Parâmetro Tipo Opcional? Descrição
Parâmetro caminho de URL groupId Cadeia de caracteres Não GUID representando o groupId do recurso de grupo específico
Cabeçalho HTTP accessToken Cadeia de caracteres Não Token de Acesso recebido do ponto de extremidade de auth
Cabeçalho HTTP Content-Type Cadeia de Caracteres Não valor: application/json

Corpo da solicitação

Parâmetro Tipo Opcional? Descrição
referenceId Cadeia de caracteres Não GUID que representa a id para referência de entidade que representa uma Ação
sourceGroupId Cadeia de caracteres Não GUID do grupo no qual a Ação foi enviada. No caso de grupos que é um subgrupo de outro grupo, isso pode ser diferente do 'groupId' fornecido no parâmetro caminho da url
reactionType Cadeia de caracteres Não Valor de enumeração: 'Like'/'Comment'
comment String Não O texto de comentário é obrigatório apenas para o reactionType 'Comment'. Para 'Like', isso deve ser ignorado

Solicitação JSON de exemplo

{
    "comment":"Comment-3",
    "referenceId":"4a44e62f-5142-a980-c7a48e2d92a8",
    "sourceGroupId":"fc6f2802-4431-b82f-60985a515b58",
    "reactionType":"Comment"
}

Corpo da resposta

Parâmetro Tipo Descrição
reactionId Cadeia de caracteres GUID que representa a ID da entidade de reação após a conclusão bem-sucedida da solicitação

Resposta JSON de exemplo

{
    "reactionId": "71df-d53a-43cc-9b73-80dcc22502ab"
}

RESUMO GET /reaction no nível de ação

GET {endpoint-url}/v1/groups/{groupId}/reaction/{referenceId}/summary?sourceGroupId={sourceGroupId}

Parâmetros de solicitação

Parâmetro Tipo Opcional? Descrição
Parâmetro caminho de URL groupId Cadeia de caracteres Não GUID representando o groupId do recurso de grupo específico
Parâmetro caminho de URL referenceId Cadeia de caracteres Não GUID que representa a id para referência de entidade que representa uma Ação
Parâmetro caminho de URL sourceGroupId Cadeia de caracteres Não GUID do grupo no qual a Ação foi enviada
Cabeçalho HTTP accessToken Cadeia de caracteres Não Token de Acesso recebido do ponto de extremidade de auth

Corpo da resposta

Parâmetro Tipo Descrição
summary Matriz JSON Matriz de objetos JSON cada um representando o resumo de reações em uma ação enviada em um grupo

Objeto resumo do corpo da resposta

Parâmetro Tipo Descrição
referenceId Cadeia de caracteres GUID que representa a id para referência de entidade que representa uma Ação
reactionsCountMap Objeto Json Objeto Json que contém likes e comentários contam para essa referenceId

Resposta JSON de exemplo

{
    "summary": [
        {
            "referenceId": "4a44e62e-4b42-a980-c7a48e2d92a8",
            "reactionsCountMap": {
                "like": 1,
                "comment": 4
            }
        }
    ]
}

RESUMO GET /reaction no nível do grupo

GET {endpoint-url}/v1/groups/{groupId}/reaction/summary?sourceGroupId={sourceGroupId}&cursor={timeStamp}

Parâmetros de solicitação

Parâmetro Tipo Opcional? Descrição
Parâmetro caminho de URL groupId Cadeia de caracteres Não GUID representando o groupId do recurso de grupo específico
Parâmetro caminho de URL sourceGroupId Cadeia de caracteres Não GUID do grupo no qual a Ação foi enviada
Parâmetro caminho de URL Cursor Timestamp Não timeStamp do qual o resumo precisa ser calculado. Valor padrão 0
Cabeçalho HTTP accessToken Cadeia de caracteres Não Token de Acesso recebido do ponto de extremidade de auth

Corpo da resposta

Parâmetro Tipo Descrição
Cursor Timestamp timeStamp até qual resumo foi calculado. O próximo conjunto de reaçõesSummary pode ser gerado usando esse valor de cursor
summary Matriz JSON Matriz de objetos JSON cada um representando o resumo de reações em uma ação enviada em um grupo

Objeto resumo do corpo da resposta

Parâmetro Tipo Descrição
referenceId Cadeia de caracteres GUID que representa a id para referência de entidade que representa uma Ação
reactionsCountMap Objeto Json Objeto Json que contém likes e comentários contam para essa referenceId

Resposta JSON de exemplo

{
    "cursor": 636674054802000000,
    "summary": [
        {
            "referenceId": "4a44-51be-4b42-a980-c7a48e2d92a8",
            "reactionsCountMap": {
                "like": 1,
                "comment": 4
            }
        },
        {
            "referenceId": "4a44-51be-4b420-c7a48e2d92a8",
            "reactionsCountMap": {
                "like": 10,
                "comment": 14
            }
        }
    ]
}

Detalhes get /reaction para uma ação

GET {endpoint-url}/v1/groups/{groupId}/reaction/{referenceId}?sourceGroupId={sourceGroupId}&reactionType={reactionType}&cursor={timeStamp}

Parâmetros de solicitação

Parâmetro Tipo Opcional? Descrição
Parâmetro caminho de URL groupId Cadeia de caracteres Não GUID representando o groupId do recurso de grupo específico
Parâmetro caminho de URL sourceGroupId Cadeia de caracteres Não GUID do grupo no qual a Ação foi enviada
Parâmetro caminho de URL referenceId Cadeia de caracteres Não GUID que representa a id para referência de entidade que representa uma Ação
Parâmetro caminho de URL reactionType Cadeia de caracteres Não Valor de enumeração: 'Like'/'Comment'
Parâmetro caminho de URL Cursor TimeStamp Não TimeStamp do qual o resumo precisa ser calculado. Valor padrão 0
Cabeçalho HTTP accessToken Cadeia de caracteres Não Token de Acesso recebido do ponto de extremidade de auth

Corpo da resposta

Parâmetro Tipo Descrição
Cursor TimeStamp TimeStamp até qual reaçãoDetail foi fornecido. O próximo conjunto de reactionDetails pode ser gerado usando esse valor de cursor
reactionDetails Matriz JSON Matriz de objetos JSON cada um representando detalhes de reações em uma ação enviada em um grupo

Objeto resumo do corpo da resposta

Parâmetro Tipo Descrição
reactionId Cadeia de caracteres GUID que representa a id para a reação criada em referenceId representando uma ação
userId Objeto Json UserId para o usuário que criou a reação em uma ação
lastModifiedTime Carimbo de data/hora Carimbo de data/hora em que a reação foi criada/atualizada

Resposta JSON de exemplo

{
    "cursor": 636674054802000000,
    "reactionDetails": [
        {
            "lastModifiedTime": 1529573303063,
            "reactionId": "4b2fb78b-b529-4fa1-acda-f670b491ebca",
            "userId": "72e29591-f391-4e7b-84eb-4e228406fb9b"
        },
        {
            "lastModifiedTime": 1529573313063,
            "reactionId": "4b2fb7529-4fa1-acda-f670b491ebca",
            "userId": "72e29591-f391-4eb-4e228406fb9b"
        }
    ]
}