/
associate_get ()

associate_get ()

Function prototype

associate_get ( session , associate )

API Version

All

 

Returns general information about an ASSOCIATE of a CASE (someone that takes care of a CASE)

If the parameter associate is null, the function returns an empty XML template.

If associate != null then this function is only permitted if:

  • The ASSOCIATE corresponds to the same session's user

  • OR the session's user is an ASSOCIATE of "associate"

  • OR the session's user is a professional AND "associate" is a new ASSOCIATE created by an invitation, but that ASSOCIATE has not joined Linkcare yet (has not signed up in Linkcare platform yet)

Input

parameters:

  • session: is the token obtained in the session_init call

  • associate: ASSOCIATE reference for whom the CONTACT data will be returned

Output

parameters:

  • result/user: an XML with all the information about n ASSOCIATE

    • ref: reference of the ASSOCIATE

    • personal_qr: QR representation of the personal data of the ASSOCIATE. Can be used in other API functions instead of the case reference (see QR OBJECT ). Introduced in API Version 2.7.28

    • pictures: list of pictures associated to the ASSOCIATE

    • data: Contact information

      • full_name: Concatenation of the name and surnames of the contact. If the name or surname contain Chinese characters, then the full name is the concatenation of the surname and name

      • informal_name: Normally consists on name of the contact. If the name or surname contain Chinese characters, then the full name is the concatenation of the surname and name. Introduced in API Version 2.7.24

      • name

      • surname

      • nickname: nickname of the USER

      • bdate: birth date

      • age: age in years

      • gender: M for male, F for female

      • status

  • ErrorMsg: any fault in the call, either in the validation of input parameters, errors in the connection to the database or any other error, this parameter returns the error message produced

  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request

sample:

associate_get( “LCAAAAAAAAAAAA”, 10261)

Response

sample:

<?xml version="1.0" encoding="UTF-8"?> <result>

<?xml version="1.0" encoding="UTF-8"?> <associate> <ref>13972</ref> <personal_qr>LKQRiiNYa-TgBhrsnSismk2udGkoylSx3cKm01egiVFRrIY</personal_qr> <username>peter983</username> <pictures> <insignia> <ref>4</ref> </insignia> </pictures> <data> <nickname>ALEXEY K</nickname> <bdate>1998-03-20</bdate> <age>17</age> <gender>F</gender> <status>ACTIVE</status> <preferences> <password_expire>false</password_expire> </preferences> </data> </associate>

</result>



Related content