Dependent APIs | |
▼SBR CSR | This SDK is used for submitting SBR business data to the SBR Core Services Channel |
▼Overview | |
Introduction | |
Third party dependencies and licensing | |
Design notes | |
Configuration | |
▼Getting Started | |
Summary | |
Startup and Shutdown | |
Using CSR | |
Getting credentials | |
Getting a SecurityToken | |
All together | |
Error handling | |
▼API | |
▼Types | General types used across the SBR CSR API |
Module defines | Each module within the library is individually defined by a name and id |
Configuration Values | These values can optionally be used to access variables in the configuration file |
Error codes | All errors are encapsulated in CSR specific errors |
Library | General (miscellaneous) library API |
CSR Service | The CSR API which encapsulates a CSR Service endpoint and the type of requests to be submitted |
▼Request and Response | This section describes Request Message and Response Message |
Request Message | A Request message contains one or more sbr_Sbdm objects, as well as a Response (after a submit) |
Response Message | A Response message contains one or more sbr_Sbdm objects |
▼Standard Business Document Message | This section describes SBDM and related sections |
SBDM | The StandardBusinessDocumentMessage (document message or SBDM), represents a collection of business documents and header information, in a Request Message or a Response Message |
SBDM Party | A sbr_Sbdm object can contain one or more sbr_MsgEventItem objects |
SBDM Receipt | The Receipt details of an sbr_Sbdm Response object |
SBDM Timestamp | A sbr_Sbdm object can contain one or more sbr_MsgTimestamp objects |
SBDM Event | A sbr_Sbdm object can contain one or more sbr_MsgEventItem objects |
The Business Document | The CSR API for a CSR Business Document object |
The Business Document Attachment | The CSR API for a CSR Business Document Attachment object |