POST CreateExam

Create an exam. Receieve infos from a CSV file encoded in Base64. The webservice returns a single status value

Received parameters

- API Key

- StoreCode: Store code

- PatientHCN: Patient's health insurance number

- OptoProfCode: Professional code of the optometrist

- String of the encoded CSV file

1 Returned value (integer) :

0 - Exam file succesfully created

1 - Store not found

2 - Store connection error

3 - Patient not found

4 - Error saving the exam file

11 - Invalid API Key

12 - Invalid CSV file

POST:/CreateExam

Request Information

URI Parameters

None.

Body Parameters

CreateExamFileRequest
NameDescriptionTypeAdditional information
ApiCode

Clé API Opti-Pro

string

None.

StoreCode

StoreCode

string

None.

FileTypeCode

Store Code

string

None.

PatientHCN

PatientHCN

string

None.

OptoProfCode

PatientHCN

string

None.

EncodedCsvtring

Fichier csv encodé

string

None.

Request Formats

application/json, text/json

Exemple:
{
  "ApiCode": "sample string 1",
  "StoreCode": "sample string 2",
  "FileTypeCode": "sample string 3",
  "PatientHCN": "sample string 4",
  "OptoProfCode": "sample string 5",
  "EncodedCsvtring": "sample string 6"
}

application/xml, text/xml

Exemple:
<CreateExamFileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WsOptiPro">
  <ApiCode>sample string 1</ApiCode>
  <EncodedCsvtring>sample string 6</EncodedCsvtring>
  <FileTypeCode>sample string 3</FileTypeCode>
  <OptoProfCode>sample string 5</OptoProfCode>
  <PatientHCN>sample string 4</PatientHCN>
  <StoreCode>sample string 2</StoreCode>
</CreateExamFileRequest>

application/x-www-form-urlencoded

Exemple:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateExamFileRequest'.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Exemple:
1

application/xml, text/xml

Exemple:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>