Courriers

Création d'un courrier

post

Création d'un courrier

Authorizations

basicAuth

AuthorizationstringRequired

Body

application/json

encodedFilestringOptionalExample: Q2VjaSBlc3QgdW4gZG9jdW1lbnQgdGV4dGUgZGUgZMOpbW9uc3RyYXRpb24=

formatstringOptionalExample: txt

statusstringOptionalExample: NEW

chronobooleanOptionalExample: true

doctypenumberOptionalExample: 1204

modelIdnumberOptionalExample: 1

typistnumberOptionalExample: 2

subjectstringOptionalExample: Ceci est un courrier de test

destinationnumberOptionalExample: 2

arrivalDatestringOptionalExample: YYYY-MM-DD

documentDatestringOptionalExample: YYYY-MM-DD

Responses

200

Opération réalisée avec succès

application/json

resIdnumberOptionalExample: 100

post

/resources

HTTPcURLJavaScriptPython

POST /rest/resources HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "encodedFile": "Q2VjaSBlc3QgdW4gZG9jdW1lbnQgdGV4dGUgZGUgZMOpbW9uc3RyYXRpb24=",
  "format": "txt",
  "status": "NEW",
  "chrono": true,
  "doctype": 1204,
  "modelId": 1,
  "typist": 2,
  "subject": "Ceci est un courrier de test",
  "destination": 2,
  "senders": [
    {
      "id": 1,
      "type": "contact"
    }
  ],
  "arrivalDate": "YYYY-MM-DD",
  "documentDate": "YYYY-MM-DD"
}

200

Opération réalisée avec succès

{
  "resId": 100
}

Récupération des informations complètes d'un courrier

get

Récupération des informations complètes d'un courrier

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

res_idstringRequiredExample: 100

Responses

200

Opération réalisée avec succès

application/json

resIdnumberOptionalExample: 100

modelIdnumberOptionalExample: 1

typistnumberOptionalExample: 15

categoryIdstringOptionalExample: incoming

chronostringOptionalExample: 2023/A/00039

statusstringOptionalExample: NEW

externalIdanyOptional

closingDatestringOptional

creationDatestringOptionalExample: 2023-04-26 10:31:54.574709

modificationDatestringOptionalExample: 2023-11-15 10:35:57.210632

retentionFrozenbooleanOptionalExample: false

bindingstringOptional

integrationsobjectOptionalExample: {"inShipping":false,"inSignatureBook":false}

subjectstringOptionalExample: Candidature au poste de secrétaire administrative du pôle jeunesse

processLimitDatestringOptionalExample: 2023-05-29 23:59:59

prioritystringOptionalExample: poiuytre1357nbvc

doctypenumberOptionalExample: 7061

destinationnumberOptionalExample: 11

documentDatestringOptionalExample: 2023-04-05 00:00:00

arrivalDatestringOptionalExample: 2023-04-26 00:00:00

destinationLabelstringOptionalExample: Direction des Richesses Humaines

statusLabelstringOptionalExample: Nouveau

statusAlterablebooleanOptionalExample: true

priorityLabelstringOptionalExample: Normal

priorityColorstringOptionalExample: #008040

customFieldsobjectOptionalExample: {"3":"Courrier simple"}

foldersarrayOptionalExample: [1,2,3]

tagsarrayOptionalExample: [1,2,3]

canUpdatebooleanOptionalExample: true

canDeletebooleanOptionalExample: false

get

/resources/{res_id}

HTTPcURLJavaScriptPython

GET /rest/resources/{res_id} HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "resId": 100,
  "modelId": 1,
  "typist": 15,
  "categoryId": "incoming",
  "chrono": "2023/A/00039",
  "status": "NEW",
  "externalId": null,
  "closingDate": null,
  "creationDate": "2023-04-26 10:31:54.574709",
  "modificationDate": "2023-11-15 10:35:57.210632",
  "retentionFrozen": false,
  "binding": null,
  "integrations": {
    "inShipping": false,
    "inSignatureBook": false
  },
  "subject": "Candidature au poste de secrétaire administrative du pôle jeunesse",
  "processLimitDate": "2023-05-29 23:59:59",
  "priority": "poiuytre1357nbvc",
  "doctype": 7061,
  "destination": 11,
  "documentDate": "2023-04-05 00:00:00",
  "arrivalDate": "2023-04-26 00:00:00",
  "destinationLabel": "Direction des Richesses Humaines",
  "statusLabel": "Nouveau",
  "statusAlterable": true,
  "priorityLabel": "Normal",
  "priorityColor": "#008040",
  "senders": [
    {
      "id": 1,
      "type": "contact"
    }
  ],
  "customFields": {
    "3": "Courrier simple"
  },
  "folders": "[1,2,3]",
  "tags": "[1,2,3]",
  "canUpdate": true,
  "canDelete": false
}

Modification du status d'un courrier

put

Modification du status d'un courrier

Authorizations

basicAuth

AuthorizationstringRequired

Body

application/json

statusstringOptionalExample: END

resIdarrayOptionalExample: [100]

historyMessagestringOptionalExample: Test de modification du status

Responses

200

Opération réalisée avec succès

application/json

successstringOptionalExample: success

put

/res/resource/status

HTTPcURLJavaScriptPython

PUT /rest/res/resource/status HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "status": "END",
  "resId": [
    100
  ],
  "historyMessage": "Test de modification du status"
}

200

Opération réalisée avec succès

{
  "success": "success"
}

Récupération du document principal d'un courrier

get

Récupération du document principal d'un courrier

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

res_idstringRequiredExample: 100

Responses

200

Opération réalisée avec succès

application/json

get

/resources/{res_id}/content

HTTPcURLJavaScriptPython

GET /rest/resources/{res_id}/content HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "encodedDocument": "BASE_64_ENCODED_DOCUMENT"
}