SCHEDULE

Temos a presença de um campo chamado externalId (Id Externo), utilizado para controle de agendamentos feitos por fora do sistema, podemos utilizar as querys params para efetuar uma pesquisa usando como base esse id externo, segue o exemplo:
https://localhost:4514/api/v1/screening?externalId=1

O campo não é obrigatório, caso não seja mandado na requisição de cadastro será definido como null, impedindo o rastreamento por id externo, o mesmo é uma string possibilitando o envio de ids de bancos não relacionais como o MongoDB.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
			"examiner": {
				"id": 1,
				"firstName": "Doctor",
				"middleName": "Test",
				"lastName": "Zscan",
				"birthDate": "1973-12-10",
				"gender": {
					"id": 1
				},
				"maritalStatus": {
					"id": 2
				},
				"signText": null,
				"profile": null,
				"documents": [],
				"contacts": {},
				"user": null,
				"occupations": null,
				"iLaudoPassword": null,
				"iLaudoSynchronized": false,
				"iLaudoLastSynchronization": null,
				"externalId": null,
				"simpleRecord": false,
				"userCreated": {
					"id": 1
				},
				"userChanged": {
					"id": 1
				},
				"userDeleted": {
					"id": null
				},
				"dateHourCreated": "2018-10-30T16:58:53.000Z",
				"dateHourChanged": "2019-03-14T16:46:15.000Z",
				"dateHourDeleted": null
			},
			"requester":{
      "id":null,
      "firstName":"AUGUSTO",
      "middleName":"FREDERICO",
      "lastName":"XAVIER",
      "iLaudoPassword":null,
      "maritalStatus":{
         "id":"5"
      },
      "gender":{
         "id":"3"
      },
      "occupations":{
         "id":"33"
      },
      "profile":"physician",
      "sign":"https://localhost:4514/images/images/no-sign.png",
      "signText":null,
      "simpleRecord":true,
      "user":null,
      "userCreated":{
         "id":-1
      }
   },
			"patient": {
				"id": 1,
				"externalId": null,
				"firstName": "Zscan",
				"middleName": "Patient",
				"lastName": "Test",
				"mother": "Test Zscan Software",
				"father": "Test Zscan Software",
				"birthDate": "1992-10-10",
				"gender": {
					"id": 1
				},
				"maritalStatus": {
					"id": 3
				},
				"photo": "",
				"nationality": "",
				"schooling": {
					"id": null
				},
				"defaultHealthPlan": {
					"id": null
				},
				"physicianRequester": null,
				"companions": [],
				"occupation": [],
				"unit": {
					"id": null
				},
				"screening": [],
				"documents": [],
				"contacts": [],
				"insurance": [],
				"images": [],
				"videos": [],
				"reports": [],
				"prescription": [],
				"notes": [],
				"ilaudoAccess": null,
				"userCreated": {
					"id": -1
				},
				"userChanged": {
					"id": null
				},
				"userDeleted": {
					"id": null
				},
				"dateHourCreated": "2018-12-14T18:06:19.000Z",
				"dateHourChanged": "2019-03-07T14:37:38.000Z",
				"dateHourDeleted": null
			},
			"exam": {
				"id": 133,
				"name": "Exame Teste",
				"title": "Exame Teste",
				"template": {
					"id": 129
				},
				"language": "PT-BR",
				"actived": true,
				"externalId": null,
				"userCreated": {
					"id": 1
				},
				"userChanged": {
					"id": null
				},
				"userDeleted": {
					"id": null
				},
				"dateHourCreated": "2024-10-28T12:27:54.000Z",
				"dateHourChanged": "2024-10-28T12:27:54.000Z",
				"dateHourDeleted": null
			},
			"unit": {
				"id": 1,
				"name": "Unidade Teste",
				"externalId": "1",
				"cnes": null,
				"userCreated": {
					"id": 1268
				},
				"userChanged": {
					"id": null
				},
				"userDeleted": {
					"id": null
				},
				"dateHourCreated": "2024-10-29T12:34:10.000Z",
				"dateHourChanged": "2024-10-29T12:34:10.000Z",
				"dateHourDeleted": null
			},
			"dateHourInit": "2024-10-30T13:00:00.000Z",
			"dateHourEnd": "2024-10-30T13:30:00.000Z",
			"description": "",
			"title": "",
			"color": "#ffffcc",
			"type": "E",
			"status": 1,
			"externalId": "203579666",
			"userCreated": {
				"id": -1
			},
			"userChanged": {
				"id": -1
			},
			"userDeleted": {
				"id": -1
			},
			"dateHourCreated": "2024-10-29T12:36:54.000Z",
			"dateHourChanged": "2024-10-29T12:36:54.000Z",
			"dateHourDeleted": null
		}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://prod.your-api-server.com/api/v1/schedule' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
			"examiner": {
				"id": 1,
				"firstName": "Doctor",
				"middleName": "Test",
				"lastName": "Zscan",
				"birthDate": "1973-12-10",
				"gender": {
					"id": 1
				},
				"maritalStatus": {
					"id": 2
				},
				"signText": null,
				"profile": null,
				"documents": [],
				"contacts": {},
				"user": null,
				"occupations": null,
				"iLaudoPassword": null,
				"iLaudoSynchronized": false,
				"iLaudoLastSynchronization": null,
				"externalId": null,
				"simpleRecord": false,
				"userCreated": {
					"id": 1
				},
				"userChanged": {
					"id": 1
				},
				"userDeleted": {
					"id": null
				},
				"dateHourCreated": "2018-10-30T16:58:53.000Z",
				"dateHourChanged": "2019-03-14T16:46:15.000Z",
				"dateHourDeleted": null
			},
			"requester":{
      "id":null,
      "firstName":"AUGUSTO",
      "middleName":"FREDERICO",
      "lastName":"XAVIER",
      "iLaudoPassword":null,
      "maritalStatus":{
         "id":"5"
      },
      "gender":{
         "id":"3"
      },
      "occupations":{
         "id":"33"
      },
      "profile":"physician",
      "sign":"https://localhost:4514/images/images/no-sign.png",
      "signText":null,
      "simpleRecord":true,
      "user":null,
      "userCreated":{
         "id":-1
      }
   },
			"patient": {
				"id": 1,
				"externalId": null,
				"firstName": "Zscan",
				"middleName": "Patient",
				"lastName": "Test",
				"mother": "Test Zscan Software",
				"father": "Test Zscan Software",
				"birthDate": "1992-10-10",
				"gender": {
					"id": 1
				},
				"maritalStatus": {
					"id": 3
				},
				"photo": "",
				"nationality": "",
				"schooling": {
					"id": null
				},
				"defaultHealthPlan": {
					"id": null
				},
				"physicianRequester": null,
				"companions": [],
				"occupation": [],
				"unit": {
					"id": null
				},
				"screening": [],
				"documents": [],
				"contacts": [],
				"insurance": [],
				"images": [],
				"videos": [],
				"reports": [],
				"prescription": [],
				"notes": [],
				"ilaudoAccess": null,
				"userCreated": {
					"id": -1
				},
				"userChanged": {
					"id": null
				},
				"userDeleted": {
					"id": null
				},
				"dateHourCreated": "2018-12-14T18:06:19.000Z",
				"dateHourChanged": "2019-03-07T14:37:38.000Z",
				"dateHourDeleted": null
			},
			"exam": {
				"id": 133,
				"name": "Exame Teste",
				"title": "Exame Teste",
				"template": {
					"id": 129
				},
				"language": "PT-BR",
				"actived": true,
				"externalId": null,
				"userCreated": {
					"id": 1
				},
				"userChanged": {
					"id": null
				},
				"userDeleted": {
					"id": null
				},
				"dateHourCreated": "2024-10-28T12:27:54.000Z",
				"dateHourChanged": "2024-10-28T12:27:54.000Z",
				"dateHourDeleted": null
			},
			"unit": {
				"id": 1,
				"name": "Unidade Teste",
				"externalId": "1",
				"cnes": null,
				"userCreated": {
					"id": 1268
				},
				"userChanged": {
					"id": null
				},
				"userDeleted": {
					"id": null
				},
				"dateHourCreated": "2024-10-29T12:34:10.000Z",
				"dateHourChanged": "2024-10-29T12:34:10.000Z",
				"dateHourDeleted": null
			},
			"dateHourInit": "2024-10-30T13:00:00.000Z",
			"dateHourEnd": "2024-10-30T13:30:00.000Z",
			"description": "",
			"title": "",
			"color": "#ffffcc",
			"type": "E",
			"status": 1,
			"externalId": "203579666",
			"userCreated": {
				"id": -1
			},
			"userChanged": {
				"id": -1
			},
			"userDeleted": {
				"id": -1
			},
			"dateHourCreated": "2024-10-29T12:36:54.000Z",
			"dateHourChanged": "2024-10-29T12:36:54.000Z",
			"dateHourDeleted": null
		}'

Requisição

Exemplos de Requisição

Respostas