PT
Español
English
Português
    Criação de Ordens

    A operação relacionada para criar ordens de serviço é descrita.

    Detalhes da solicitação:

    • URL base: {host}/AFLSAPI/
    • URI: api/ordens de serviço

    • Tipo: POST

    • Títulos obrigatórios:

    • Tipo de conteúdo: application/json
    • Autorização X: Portador {token}

    Descrição do URL

    • {host}: Ele representa o domínio do ambiente no qual a API está localizada.
    • AFLSAPI/: Prefixo de API fixo.
    • URI: Ponto de extremidade específico para a solicitação.


    ⚐ URL DE EXEMPLO:

    https://{host}/AFLSAPI/api/workorders


    Parâmetros:

    Nome Tipo de dado Obrigatório Descrição
    endereçoContato Corda Sim Endereço de contato
    addressContactInfo Corda Não Informações de endereço de contato
    assignmentType Inteiro Não Tipo de Atribuição
    ID do cliente Inteiro Sim ID do cliente
    ID da empresa Inteiro Não ID da empresa
    contatoE-mail Corda Não E-mail de contato
    contatoLatitude Número - Duplo Sim Latitude do endereço de contato
    de contatoLongitude Número - Duplo Sim Comprimento da direção do contato
    nome do contato Corda Sim Nome do contato
    contatoTelefone Corda Não Número de telefone de contato
    creatorId Inteiro Não ID de usuário do criador da ordem de serviço
    Descrição Corda Sim Descrição da ordem de serviço
    endereço final Corda Não Endereço final
    endAddressInfo Corda Não Informações finais sobre o endereço
    endLatitude Número - Duplo Não Latitude do endereço final
    endLongitude Número - Duplo Não Comprimento final do endereço
    Id Inteiro Não Id de la WorkOrder
    prioridade Inteiro Sim Tipo de prioridade: 0 - Normal, 1 - Emergência, 2 - Prioridade
    ID do provedor Inteiro Não ID do provedor
    ID do serviço Inteiro Sim Serviço associado ao pedido
    idécido especialista Inteiro Não Identificação do especialista assistente
    estado Inteiro Sim Status do pedido - Somente valor: 1
    Assunto Corda Sim Assunto ou título da ordem
    subStateId Inteiro Não Subpropriedade
    ID do bilhete Corda Não Encomendar Bilhete
    dataDeTérmino de atenção string - data e hora Não Data de fim do atendimento
    dataDeiníciodeatenção string - data e hora Não Data de início do atendimento
    data_final_de_atençãoprovisória string - data e hora Não Data provisória de fim do atendimento
    tentativeAttentionStartDate string - data e hora Não Data de Atenção Provisória
    data_de_iníciodeviagemdeViagem provisória string - data e hora Não Data de início da viagem
    data_de_iníciodeviagem string - data e hora Não Data de início da viagem
    Campos adicionais Array Não Listar campos adicionais
    Anexos Array Não Lista de anexos
    Produtos Array Não Listar produtos para serviço
    workTasks Array Não Lista de tarefas da ordem de serviço

    Corpo da petição:

    A solicitação consiste em um objeto JSON. Exemplo:

    {
    "addressContact": "Calle 39B, Teusaquillo, 11311 Teusaquillo, Distrito Capital, Colombia",
    "addressContactInfo": "",
    "clientId": 24,
    "companyId": null,
    "contactEmail": "tati@pruebas.com",
    "contactLatitude": 4.629124230469785,
    "contactLongitude": -74.0730822280432,
    "contactName": "Cración de Ordenes con campos adicionales",
    "contactPhone": null,
    "description": "Cración de Ordenes con campos adicionales API WORKORDER",
    "endAddress": "",
    "endAddressInfo": "",
    "endLatitude": 0,
    "endLongitude": 0,
    "id": 0,
    "priority": 0,
    "serviceId": 36,
    "state": 1,
    "subject": "Cración de Ordenes con campos adicionales",
    "subStateId": 1,
    "attentionEndDate": "",
    "attentionStartDate": "",
    "tentativeAttentionEndDate": "",
    "tentativeAttentionStartDate": "",
    "tentativeTravelStartDate": "",
    "travelStartDate": "",
    "additionalFields": [
        {
            "id": 24,
            "value": "3"
        },
        {
            "id": 24,
            "value": "Esta son unas pruebas para campo adicional tipo parrafo"
        }
    ],
    "products": [
        {
            "cost": 0,
            "description": "",
            "id": 0,
            "isActive": true,
            "name": "",
            "productId": 4,
            "quantity": 1,
            "sku": "",
            "typeProduct": 0
        }
    ],
    "workTasks": null
}

    Responder:

    Como resposta, um objeto JSON é obtido, com o seguinte informação:

     {
    "addressContact": "Floresta Outlet, Carrera 69, Santa Rosa, 11121 Suba, Distrito Capital, Colombia",
    "addressContactInfo": "Piso 7",
    "assignmentType": 0,
    "clientId": 213,
    "companyId": null,
    "contactEmail": "tati@pruebas.com",
    "contactLatitude": 4.6919158,
    "contactLongitude": -74.0745394,
    "contactName": "PRUEBAS CREACIÓN DE ORDENES DESDE LA API DE WORKORDERS",
    "contactPhone": "30122222222",
    "creatorId": 3,
    "description": "PRUEBAS CREACIÓN DE ORDENES DESDE LA API DE WORKORDERS",
    "endAddress": null,
    "endAddressInfo": "",
    "endLatitude": 0.0,
    "endLongitude": 0.0,
    "id": 87,
    "priority": 1,
    "providerId": 2,
    "serviceId": 1,
    "specialistId": 11,
    "state": 1,
    "subject": "Pruebas de Creación de orden de Emergencia",
    "subStateId": 10,
    "ticketId": "87",
    "attentionEndDate": null,
    "attentionStartDate": null,
    "tentativeAttentionEndDate": "2024-03-20T01:12:27.079+00:00",
    "tentativeAttentionStartDate": "2024-03-19T22:12:27.079+00:00",
    "tentativeTravelStartDate": "2024-03-19T22:12:27.079+00:00",
    "travelStartDate": null,
    "additionalFields": [
        {
            "actions": null,
            "definitionId": 1,
            "description": null,
            "formatValidator": null,
            "helpMessage": "Campo orden simple",
            "id": 4,
            "itemId": 0,
            "keepHistory": false,
            "label": "Campo orden simple",
            "name": "ca-campo orden simple-1",
            "options": null,
            "order": 1,
            "permissions": [
                {
                    "statusId": 7,
                    "name": "General",
                    "roles": [
                        {
                            "actions": {
                                "edit": true,
                                "required": false,
                                "view": true
                            },
                            "id": 276,
                            "name": "AFLS_Dispatcher"
                        },
                        {
                            "actions": {
                                "edit": true,
                                "required": false,
                                "view": true
                            },
                            "id": 278,
                            "name": "AFLS_Monitor"
                        }
                    ]
                }
            ],
            "state": null,
            "status": true,
            "typeId": 1,
            "value": null
        }
    ],
    "attachments": [
        {
            "createDate": "2024-03-19T22:24:37.607+00:00",
            "description": null,
            "fileExtension": "pdf",
            "filePath": null,
            "fileSize": "182848",
            "id": 6,
            "realFileName": "PRUEBA",
            "serveFileName": null
        }
    ],
    "products": [
        {
            "cost": 10000.00,
            "description": "Cable",
            "id": 11,
            "isActive": true,
            "name": "Cable",
            "productId": 1,
            "quantity": 2,
            "sku": "001",
            "typeProduct": 0
        }
    ],
    "workTasks": null
}

    Mensagens de erro:

    Código Status HTTP Mensagem de erro
    400 Solicitação BadRequest ServiceId não relacionado ao clientId
    400 Solicitação BadRequest ProductId x não encontrado.
    400 Solicitação BadRequest AdditionalField x não encontrado.
    400 Solicitação BadRequest ClientId não é válido.
    400 Solicitação BadRequest O cliente x está inativo
    400 Solicitação BadRequest O Serviço Padrão não requer EndAddress, EndLatitude ou EndLongitude.
    400 Solicitação BadRequest O serviço x está inativo.
    400 Solicitação BadRequest AssignmentType não encontrado.
    400 Solicitação BadRequest SpecialistId não encontrado.
    400 Solicitação BadRequest O estado da ordem de trabalho não é válido.
    400 Solicitação BadRequest EndAddress, EndLatitude e EndLongitude são obrigatórios.
    400 Solicitação BadRequest AddressContact, ContactLatitude e ContactLongitude são obrigatórios.
    401 Desautorizado A autorização foi negada para esta solicitação.
    500 Erro interno do servidor FalhaLogin