WS-RESTRICTED_API Host [RESTRICTED_API] : D5290-staging

<back to all web services

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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WS_RESTRICTED_API

Namespace Global

    Namespace WS_RESTRICTED_API

        '''<Summary>
        '''Service de création de documents
        '''</Summary>
        <Api(Description:="Service de création de documents")>
        Public Partial Class document
            '''<Summary>
            '''document type
            '''</Summary>
            <ApiMember(DataType:="string", Description:="document type", IsRequired:=true, Name:="DocumentType", ParameterType:="path")>
            Public Overridable Property DocumentType As eapi_document_type_enum

            '''<Summary>
            '''n° entrepot
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="n° entrepot", IsRequired:=true, Name:="IdEntrepot", ParameterType:="path")>
            Public Overridable Property IdEntrepot As Integer

            '''<Summary>
            '''n° groupe
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="n° groupe", IsRequired:=true, Name:="IdGroupe", ParameterType:="path")>
            Public Overridable Property IdGroupe As Integer

            '''<Summary>
            '''n° client
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="n° client", IsRequired:=true, Name:="IdSociete", ParameterType:="path")>
            Public Overridable Property IdSociete As Integer

            '''<Summary>
            '''n° document
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="n° document", IsRequired:=true, Name:="IdDocument", ParameterType:="path", Route:="/document/{DocumentType}/{IdEntrepot}/{IdSociete}/{IdDocument}")>
            Public Overridable Property IdDocument As Integer

            '''<Summary>
            '''année
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="année", IsRequired:=true, Name:="Year", ParameterType:="path", Route:="/document/{DocumentType}/{IdEntrepot}/{IdSociete}/{Year}/{Month}")>
            Public Overridable Property Year As Integer

            '''<Summary>
            '''mois
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="mois", IsRequired:=true, Name:="Month", ParameterType:="path", Route:="/document/{DocumentType}/{IdEntrepot}/{IdSociete}/{Year}/{Month}")>
            Public Overridable Property Month As Integer
        End Class

        '''<Summary>
        '''Service de création de documents (OLD SCHOOL)
        '''</Summary>
        <Api(Description:="Service de création de documents (OLD SCHOOL)")>
        Public Partial Class document_forced
            '''<Summary>
            '''Basic Auth
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Basic Auth", IsRequired:=true, Name:="BasicAuth", ParameterType:="path")>
            Public Overridable Property BasicAuth As String

            '''<Summary>
            '''mime-type
            '''</Summary>
            <ApiMember(DataType:="string", Description:="mime-type", IsRequired:=true, Name:="MimeType", ParameterType:="path")>
            Public Overridable Property MimeType As String

            '''<Summary>
            '''document type
            '''</Summary>
            <ApiMember(DataType:="string", Description:="document type", IsRequired:=true, Name:="DocumentType", ParameterType:="path")>
            Public Overridable Property DocumentType As eapi_document_type_enum

            '''<Summary>
            '''n° entrepot
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="n° entrepot", IsRequired:=true, Name:="IdEntrepot", ParameterType:="path")>
            Public Overridable Property IdEntrepot As Integer

            '''<Summary>
            '''n° groupe
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="n° groupe", IsRequired:=true, Name:="IdGroupe", ParameterType:="path")>
            Public Overridable Property IdGroupe As Integer

            '''<Summary>
            '''n° client
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="n° client", IsRequired:=true, Name:="IdSociete", ParameterType:="path")>
            Public Overridable Property IdSociete As Integer

            '''<Summary>
            '''n° document
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="n° document", IsRequired:=true, Name:="IdDocument", ParameterType:="path", Route:="/document_forced/{BasicAuth}/{MimeType}/{DocumentType}/{IdEntrepot}/{IdSociete}/{IdDocument}")>
            Public Overridable Property IdDocument As Integer

            '''<Summary>
            '''année
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="année", IsRequired:=true, Name:="Year", ParameterType:="path", Route:="/document_forced/{BasicAuth}/{MimeType}/{DocumentType}/{IdEntrepot}/{IdSociete}/{Year}/{Month}")>
            Public Overridable Property Year As Integer

            '''<Summary>
            '''mois
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="mois", IsRequired:=true, Name:="Month", ParameterType:="path", Route:="/document_forced/{BasicAuth}/{MimeType}/{DocumentType}/{IdEntrepot}/{IdSociete}/{Year}/{Month}")>
            Public Overridable Property Month As Integer

            Public Overridable Property document As document
        End Class

        Public Enum eapi_document_type_enum
            facture
            commande
            r98
            r99
            balance
        End Enum
    End Namespace
End Namespace

VB.NET 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

{}