eSportWS Web Service

eSportWS

Click here for a complete list of operations.

Spows_insertUserDataAndEnrollment

Insert an Individual or Institution and inserts an enrollment
Parameters list:
ALIAS Customer identification String Mandatory
LANG Culture name used for translated field names String Optional
HELP Flag to return help node with output structure, field type and translated field names Bool(0/1 or True/False) Optional
LIGHTWEIGHT Flag to return data fields in attributes instead of nodes Bool(0/1 or True/False) Optional
INSCRICAO Group for each desired enrollment Group, one or more Mandatory
  TAX_ID Tax (Price) ID(s) (comma separated if more than one except for wait list) Uniqueidentifier Mandatory
  INS_INICIO Enrollment Beginning Date DateTime Optional
  SEASON_START Season tax enrollment starts at the beginning of next season Bool(0/1 or True/False) Optional
  MP_ID Payment Way ID Int Optional
  HOM_ID Schedule ID, can be more than one Uniqueidentifier Optional (Mandatory for wait list)
IND_PAIS Country ID (ISO31661-length 2) String Mandatory
IND_NCONT Customer Tax ID String Mandatory
INU_PASSWORD Password in clear text String Mandatory
IND_NOME Customer Name String Mandatory
IND_NOMECARTAO Customer Card Name String Optional
IND_SEGID Customer Segment String Mandatory
IND_NIB Customer NIB String Optional
IND_NOTAS Customer Notes String Optional
IND_FOTO Local server path to Customer Foto String Optional
MAX_ANEXO Segment Certificate String Optional
SEGURO_ANEXO Insurance Certificate String Optional
IND_TERMORESP Field to indicate if customer already has insurance Bool(0/1 or True/False) Optional
FRM_ID Form ID int Mandatory
FORM Form with nodes with value of all 'DETAIL' fields indicated by the Spows_selectFormDescriptor Group, one Mandatory
CHANGE_ENTITYMANAGEMENT Flag to indicate if there were changes made to entity management. If true, requires 'ind_entid' Bool(0/1 or True/False) Optional
LINK Link for mail redirection (e.g., /Accounts/Login.aspx) String Optional
MP_ID Payment Way ID (if 0 (no payment), sends confirmation email) int Optional
ENTITY Entity value for MB Payments int Optional
REFERENCE Reference value for MB Payments int Optional
VALUE Payment value for MB Payments decimal Optional
LIMIT_DATE Limit date for MB Payments Datetime Optional
WAIT_LIST Flag to enroll in waiting list instead Bool(0/1 or True/False) Optional
CONSENTS Customer Consents List Optional
  CONSENT Customer Consent Mandatory
    CONS_ID Consent ID Int Mandatory
    CONS_VALUE Consent Value Bool(0/1 or True/False) Mandatory
    MOT_ID Motive ID for global consent Int Mandatory if CONS_ID is -1 and Value is True
FAMILIARES Family members list Optional
  FAMILIAR Family member Mandatory
    AFA_INDID_CABCASAL ID of the individual that is the head of the family (use an empty value (00000000-0000-0000-0000-000000000000) for the new individual) Uniqueidentifier Mandatory
    AFA_INDID_FAMILIAR ID of the individual related to the head of the family (use an empty value (00000000-0000-0000-0000-000000000000) for the new individual) Uniqueidentifier Mandatory
    GPAR_ID Relationship Type ID Uniqueidentifier Mandatory

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Demo/ES/WebServices/eSportWebServices.asmx HTTP/1.1
Host: 62.28.251.246
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.esport.pt/webservices/Spows_insertUserDataAndEnrollment"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Spows_insertUserDataAndEnrollment xmlns="https://www.esport.pt/webservices/">
      <oParam>string</oParam>
    </Spows_insertUserDataAndEnrollment>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Spows_insertUserDataAndEnrollmentResponse xmlns="https://www.esport.pt/webservices/">
      <Spows_insertUserDataAndEnrollmentResult>string</Spows_insertUserDataAndEnrollmentResult>
    </Spows_insertUserDataAndEnrollmentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Demo/ES/WebServices/eSportWebServices.asmx HTTP/1.1
Host: 62.28.251.246
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Spows_insertUserDataAndEnrollment xmlns="https://www.esport.pt/webservices/">
      <oParam>string</oParam>
    </Spows_insertUserDataAndEnrollment>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Spows_insertUserDataAndEnrollmentResponse xmlns="https://www.esport.pt/webservices/">
      <Spows_insertUserDataAndEnrollmentResult>string</Spows_insertUserDataAndEnrollmentResult>
    </Spows_insertUserDataAndEnrollmentResponse>
  </soap12:Body>
</soap12:Envelope>

Insert an Individual or Institution and inserts an enrollment
Parameters list:
ALIAS	Customer identification	String	Mandatory
LANG	Culture name used for translated field names	String	Optional
HELP	Flag to return help node with output structure, field type and translated field names	Bool(0/1 or True/False)	Optional
LIGHTWEIGHT	Flag to return data fields in attributes instead of nodes	Bool(0/1 or True/False)	Optional
INSCRICAO	Group for each desired enrollment	Group, one or more	Mandatory
TAX_ID	Tax (Price) ID(s) (comma separated if more than one except for wait list)	Uniqueidentifier	Mandatory
INS_INICIO	Enrollment Beginning Date	DateTime	Optional
SEASON_START	Season tax enrollment starts at the beginning of next season	Bool(0/1 or True/False)	Optional
MP_ID	Payment Way ID	Int	Optional
HOM_ID	Schedule ID, can be more than one	Uniqueidentifier	Optional (Mandatory for wait list)
IND_PAIS	Country ID (ISO31661-length 2)	String	Mandatory
IND_NCONT	Customer Tax ID	String	Mandatory
INU_PASSWORD	Password in clear text	String	Mandatory
IND_NOME	Customer Name	String	Mandatory
IND_NOMECARTAO	Customer Card Name	String	Optional
IND_SEGID	Customer Segment	String	Mandatory
IND_NIB	Customer NIB	String	Optional
IND_NOTAS	Customer Notes	String	Optional
IND_FOTO	Local server path to Customer Foto	String	Optional
MAX_ANEXO	Segment Certificate	String	Optional
SEGURO_ANEXO	Insurance Certificate	String	Optional
IND_TERMORESP	Field to indicate if customer already has insurance	Bool(0/1 or True/False)	Optional
FRM_ID	Form ID	int	Mandatory
FORM	Form with nodes with value of all 'DETAIL' fields indicated by the Spows_selectFormDescriptor	Group, one	Mandatory
CHANGE_ENTITYMANAGEMENT	Flag to indicate if there were changes made to entity management. If true, requires 'ind_entid'	Bool(0/1 or True/False)	Optional
LINK	Link for mail redirection (e.g., /Accounts/Login.aspx)	String	Optional
MP_ID	Payment Way ID (if 0 (no payment), sends confirmation email)	int	Optional
ENTITY	Entity value for MB Payments	int	Optional
REFERENCE	Reference value for MB Payments	int	Optional
VALUE	Payment value for MB Payments	decimal	Optional
LIMIT_DATE	Limit date for MB Payments	Datetime	Optional
WAIT_LIST	Flag to enroll in waiting list instead	Bool(0/1 or True/False)	Optional
CONSENTS	Customer Consents List		Optional
CONSENT	Customer Consent		Mandatory
CONS_ID	Consent ID	Int	Mandatory
CONS_VALUE	Consent Value	Bool(0/1 or True/False)	Mandatory
MOT_ID	Motive ID for global consent	Int	Mandatory if CONS_ID is -1 and Value is True
FAMILIARES	Family members list		Optional
FAMILIAR	Family member		Mandatory
AFA_INDID_CABCASAL	ID of the individual that is the head of the family (use an empty value (00000000-0000-0000-0000-000000000000) for the new individual)	Uniqueidentifier	Mandatory
AFA_INDID_FAMILIAR	ID of the individual related to the head of the family (use an empty value (00000000-0000-0000-0000-000000000000) for the new individual)	Uniqueidentifier	Mandatory
GPAR_ID	Relationship Type ID	Uniqueidentifier	Mandatory