יצירת כרטיס רכישה בAPI

במערכת Powerlink ניתן ליצור רשומה דרך התממשקות ל API.

 

להגדרות שימוש ב HTTP REST API לחצו כאן
 

כיצד ליצור רשומה חדשה ב- API
 

יצירת רשומה חדשה מתבצעת עם פעולת Create.

 

Action: Create

Method: POST

URLhttps://api.powerlink.co.il/api/record/{record}

את ה {record} נחליף בשם המערכת של האוביקט או במספר האובייקט בו נרצה ליצור רשומה חדשה.

במקרה שלנו, ה {record} של אובייקט רכישה הוא 33 (AccountProduct)

 

בגוף השאילתה נרשום ב JSON את הערכים והשדות של הרשומה החדשה.


כדי למצוא את שמות המערכת של השדות נוכל להכנס למצב עריכת רשומה דרך גלגל השיניים האפור הקטן ליד כל טופס >> נלחץ על העיפרון האפור לצד השדה, ובחלון שייפתח יופיע שם המערכת.
לדוגמא, השדה "מחיר" באובייקט רכישה נקרא price.

 

 

מבנה גוף השאילתא עם ערכים לדוגמה:

{

    "accountid": "9be0a2f6-6b05-48f5-bbfc-c662755719c8",

    "productid": "134f1611-d5c6-4c89-bec7-a667a83ea00c",

    "quantity": "1",

    "price": "300",

    "ownerid": "9137b287-aded-4f45-9642-006b362dfb44"

}

 

נפתח סוגריים מסולסלים { } שבתוכן נזין בכל שורה את שם המערכת של השדה ואת הערך שנרצה ליצור.
במידה ונרצה להוסיף יותר משדה אחד, נפריד בין השדות והערכים בפסיק.

 

מומלץ להיעזר בכלי API Explorer לצורך בניית ה JSON.

 

במידה ומדובר בשדות מסוג רשומה מקושרת נצטרך להזין את הID של הרשומה המבוקשת ולא את השם שלה, כפי שמצויין בדוגמה הנ"ל. קראו במאמרים הבאים מידע נוסף על רשומה מקושרת בAPI ועל שאילתות לקבלת ID של רשומה.

 

במידה ומדובר בשדה מסוג תיבת בחירה, לאחר הזנת שם המערכת של השדה, יש להזין את המספר המייצג את הערך בו אנו מעוניינים. לצורך הדוגמה, statuscode, זהו שם המערכת של השדה סטטוס. המספר 1, מייצג את הערך "פעיל" והמספר 2 מייג את הערך "לא פעיל".

 

דרך נוספת המאפשרת איתור שמות שדות וערכים מספריים של שדות מסוג תיבת בחירה בכל האובייקטים היא באמצעות פקודת GET. על כך תוכלו לקרוא במאמר הבא

הערה חשובה:

במידה ומדובר במילוי אחד משדות הרשומה בערך המכיל גרשיים ("), יש להוסיף מלפני ואחרי הערך '_' במקום "_".

לדוגמא- מילוי השדה שם יצרן - vendorname בערך חברה בע"מ:

{

"vendorname" : 'חברה בע"מ'

}

לאחר שנריץ את השאילתא נקבל הודעה על הצלחה (200), ההודעה תיהיה בפורמט JSON ותכיל את פרטי הרשומה.

דוגמה לתשובה של השרת לאחר הצלחה של הוספת כרטיס רכישה חדש למערכת:

שימו לב לערכים המסומנים בצהוב. אלו הם אותם ערכים שהכנסנו בגוף השאילתא.
השדות שלא נכללו בשאילתא קיבלו את ערכי ברירת המחדל במערכת או נשארו ריקים (null).

{

    "success": true,

    "data": {

        "Record": {

            "accountproductid": "b3a4e2f8-8319-498f-857f-e43ffab27f1f",

            "createdby": "7199015e-d86b-4886-a0d5-febad4a83298",

            "modifiedby": "7199015e-d86b-4886-a0d5-febad4a83298",

            "ownerid": "9137b287-aded-4f45-9642-006b362dfb44",

            "statuscode": null,

            "productid": "134f1611-d5c6-4c89-bec7-a667a83ea00c"

            "accountid": "9be0a2f6-6b05-48f5-bbfc-c662755719c8",

            "purchasedate": null,

            "price": 300.0000,

            "installdate": null,

            "ordinalnumber": null,

            "createdon": "2021-06-08T19:23:37",

            "description": null,

            "expiredate": null,

            "service": null,

            "modifiedon": "2021-06-08T19:23:37",

            "quantity": 1.0000,

            "createdbyname": "ספיר בחר",

            "modifiedbyname": "ספיר בחר",

            "ownername": "אליהו כהן",

            "productname": "שעת הדרכה",

            "accountname": "אבי אביבי"

        }

    },

    "message": ""

}