WS-RESTRICTED_API Host [RESTRICTED

document_forced

Document

Service de création de documents (OLD SCHOOL)

The following routes are available for this service:
GET	/document_forced/{BasicAuth}/{MimeType}/{DocumentType}/{IdEntrepot}/{IdSociete}/{IdDocument}	facture / commande
GET	/document_forced/{BasicAuth}/{MimeType}/{DocumentType}/{IdEntrepot}/{IdGroupe}/{IdSociete}/{Year}/{Month}	r99 : relevé mensuel de factures

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum eapi_document_type_enum : string
{
    case facture = 'facture';
    case commande = 'commande';
    case r98 = 'r98';
    case r99 = 'r99';
    case balance = 'balance';
}

/** @description Service de création de documents */
// @Api(Description="Service de création de documents")
class document implements JsonSerializable
{
    public function __construct(
        /** @description document type */
        // @ApiMember(DataType="string", Description="document type", IsRequired=true, Name="DocumentType", ParameterType="path")
        /** @var eapi_document_type_enum|null */
        public ?eapi_document_type_enum $documentType=null,

        /** @description n° entrepot */
        // @ApiMember(DataType="integer", Description="n° entrepot", IsRequired=true, Name="IdEntrepot", ParameterType="path")
        /** @var int */
        public int $idEntrepot=0,

        /** @description n° groupe */
        // @ApiMember(DataType="integer", Description="n° groupe", IsRequired=true, Name="IdGroupe", ParameterType="path")
        /** @var int */
        public int $idGroupe=0,

        /** @description n° client */
        // @ApiMember(DataType="integer", Description="n° client", IsRequired=true, Name="IdSociete", ParameterType="path")
        /** @var int */
        public int $idSociete=0,

        /** @description n° document */
        // @ApiMember(DataType="integer", Description="n° document", IsRequired=true, Name="IdDocument", ParameterType="path", Route="/document/{DocumentType}/{IdEntrepot}/{IdSociete}/{IdDocument}")
        /** @var int */
        public int $idDocument=0,

        /** @description année */
        // @ApiMember(DataType="integer", Description="année", IsRequired=true, Name="Year", ParameterType="path", Route="/document/{DocumentType}/{IdEntrepot}/{IdSociete}/{Year}/{Month}")
        /** @var int */
        public int $year=0,

        /** @description mois */
        // @ApiMember(DataType="integer", Description="mois", IsRequired=true, Name="Month", ParameterType="path", Route="/document/{DocumentType}/{IdEntrepot}/{IdSociete}/{Year}/{Month}")
        /** @var int */
        public int $month=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['documentType'])) $this->documentType = JsonConverters::from('eapi_document_type_enum', $o['documentType']);
        if (isset($o['idEntrepot'])) $this->idEntrepot = $o['idEntrepot'];
        if (isset($o['idGroupe'])) $this->idGroupe = $o['idGroupe'];
        if (isset($o['idSociete'])) $this->idSociete = $o['idSociete'];
        if (isset($o['idDocument'])) $this->idDocument = $o['idDocument'];
        if (isset($o['year'])) $this->year = $o['year'];
        if (isset($o['month'])) $this->month = $o['month'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->documentType)) $o['documentType'] = JsonConverters::to('eapi_document_type_enum', $this->documentType);
        if (isset($this->idEntrepot)) $o['idEntrepot'] = $this->idEntrepot;
        if (isset($this->idGroupe)) $o['idGroupe'] = $this->idGroupe;
        if (isset($this->idSociete)) $o['idSociete'] = $this->idSociete;
        if (isset($this->idDocument)) $o['idDocument'] = $this->idDocument;
        if (isset($this->year)) $o['year'] = $this->year;
        if (isset($this->month)) $o['month'] = $this->month;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Service de création de documents (OLD SCHOOL) */
// @Api(Description="Service de création de documents (OLD SCHOOL)")
class document_forced implements JsonSerializable
{
    public function __construct(
        /** @description Basic Auth */
        // @ApiMember(DataType="string", Description="Basic Auth", IsRequired=true, Name="BasicAuth", ParameterType="path")
        /** @var string */
        public string $basicAuth='',

        /** @description mime-type */
        // @ApiMember(DataType="string", Description="mime-type", IsRequired=true, Name="MimeType", ParameterType="path")
        /** @var string */
        public string $mimeType='',

        /** @description document type */
        // @ApiMember(DataType="string", Description="document type", IsRequired=true, Name="DocumentType", ParameterType="path")
        /** @var eapi_document_type_enum|null */
        public ?eapi_document_type_enum $documentType=null,

        /** @description n° entrepot */
        // @ApiMember(DataType="integer", Description="n° entrepot", IsRequired=true, Name="IdEntrepot", ParameterType="path")
        /** @var int */
        public int $idEntrepot=0,

        /** @description n° groupe */
        // @ApiMember(DataType="integer", Description="n° groupe", IsRequired=true, Name="IdGroupe", ParameterType="path")
        /** @var int */
        public int $idGroupe=0,

        /** @description n° client */
        // @ApiMember(DataType="integer", Description="n° client", IsRequired=true, Name="IdSociete", ParameterType="path")
        /** @var int */
        public int $idSociete=0,

        /** @description n° document */
        // @ApiMember(DataType="integer", Description="n° document", IsRequired=true, Name="IdDocument", ParameterType="path", Route="/document_forced/{BasicAuth}/{MimeType}/{DocumentType}/{IdEntrepot}/{IdSociete}/{IdDocument}")
        /** @var int */
        public int $idDocument=0,

        /** @description année */
        // @ApiMember(DataType="integer", Description="année", IsRequired=true, Name="Year", ParameterType="path", Route="/document_forced/{BasicAuth}/{MimeType}/{DocumentType}/{IdEntrepot}/{IdSociete}/{Year}/{Month}")
        /** @var int */
        public int $year=0,

        /** @description mois */
        // @ApiMember(DataType="integer", Description="mois", IsRequired=true, Name="Month", ParameterType="path", Route="/document_forced/{BasicAuth}/{MimeType}/{DocumentType}/{IdEntrepot}/{IdSociete}/{Year}/{Month}")
        /** @var int */
        public int $month=0,

        /** @var document|null */
        public ?document $document=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['basicAuth'])) $this->basicAuth = $o['basicAuth'];
        if (isset($o['mimeType'])) $this->mimeType = $o['mimeType'];
        if (isset($o['documentType'])) $this->documentType = JsonConverters::from('eapi_document_type_enum', $o['documentType']);
        if (isset($o['idEntrepot'])) $this->idEntrepot = $o['idEntrepot'];
        if (isset($o['idGroupe'])) $this->idGroupe = $o['idGroupe'];
        if (isset($o['idSociete'])) $this->idSociete = $o['idSociete'];
        if (isset($o['idDocument'])) $this->idDocument = $o['idDocument'];
        if (isset($o['year'])) $this->year = $o['year'];
        if (isset($o['month'])) $this->month = $o['month'];
        if (isset($o['document'])) $this->document = JsonConverters::from('document', $o['document']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->basicAuth)) $o['basicAuth'] = $this->basicAuth;
        if (isset($this->mimeType)) $o['mimeType'] = $this->mimeType;
        if (isset($this->documentType)) $o['documentType'] = JsonConverters::to('eapi_document_type_enum', $this->documentType);
        if (isset($this->idEntrepot)) $o['idEntrepot'] = $this->idEntrepot;
        if (isset($this->idGroupe)) $o['idGroupe'] = $this->idGroupe;
        if (isset($this->idSociete)) $o['idSociete'] = $this->idSociete;
        if (isset($this->idDocument)) $o['idDocument'] = $this->idDocument;
        if (isset($this->year)) $o['year'] = $this->year;
        if (isset($this->month)) $o['month'] = $this->month;
        if (isset($this->document)) $o['document'] = JsonConverters::to('document', $this->document);
        return empty($o) ? new class(){} : $o;
    }
}

PHP document_forced DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /document_forced/{BasicAuth}/{MimeType}/{DocumentType}/{IdEntrepot}/{IdSociete}/{IdDocument} HTTP/1.1 
Host: milliet.io 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}

WS-RESTRICTED_API Host [RESTRICTED_API] : D5290-staging

document_forced

Service de création de documents (OLD SCHOOL)

HTTP + JSON