POST api/AdminServices/PlaceOrderWithPartnerCreate

Accepts Partner and Order information. Creates partner if they don't already exist, then places the requested order. Will not create duplicate partners. Automatically renews existing SITE license orders. Order will not auto-fill if the partner does not order their license directly from the caller.

Request Information

URI Parameters

None.

Body Parameters

An Order/Partner Model

PlaceOrderwithPartnerCreatePost

Name	Description	Type	Additional information
CustomerId	Partner's Certiport ID	string	None.
LicenseId	ID of License being ordered	integer	None.
Quantity	Number of licenses being ordered	integer	None.
StartDate	Date the license will unlock	date	None.
PurchasePrice	purchase price is saved as a decimal and is returned in reporting. incoming value will be rounded to 2 points of precision, and no currency type is saved or accounted for.	decimal number	None.
PurchaseOrder	Purchase Order number	string	None.
ExternalOrderId	Order ID to save on the GMetrix side for reporting purposes.	string	None.
Name	Partner Name	string	None.
Country	Partner Country (If not provided, partner creation will default to United States)	string	None.
State	Partner State (If not provided, partner creation will not assign a State)	string	None.
UserName	Email address for Partner administrator (Partner administrator will only be assigned when creating a new Partner. Existing Partners will not be affected)	string	None.
FirstName	First Name of Partner administrator	string	None.
LastName	Last Name of Partner administrator	string	None.
Password	Password for Partner administrator	string	None.
SectorId	SectorId in the GM_Partner table	integer	None.
LangId	LanguageId in the GM_Partner table	integer	None.
Key	Key to Access API provided by GMetrix	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": "sample string 1",
  "LicenseId": 2,
  "Quantity": 3,
  "StartDate": "2025-05-07T01:27:48.2015538-07:00",
  "PurchasePrice": 5.1,
  "PurchaseOrder": "sample string 6",
  "ExternalOrderId": "sample string 7",
  "Name": "sample string 8",
  "Country": "sample string 9",
  "State": "sample string 10",
  "UserName": "sample string 11",
  "FirstName": "sample string 12",
  "LastName": "sample string 13",
  "Password": "sample string 14",
  "SectorId": 15,
  "LangId": 16,
  "Key": "sample string 17"
}

application/xml, text/xml

Sample:

<PlaceOrderwithPartnerCreatePost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServicesApi.Models">
  <Key>sample string 17</Key>
  <Country>sample string 9</Country>
  <CustomerId>sample string 1</CustomerId>
  <ExternalOrderId>sample string 7</ExternalOrderId>
  <FirstName>sample string 12</FirstName>
  <LangId>16</LangId>
  <LastName>sample string 13</LastName>
  <LicenseId>2</LicenseId>
  <Name>sample string 8</Name>
  <Password>sample string 14</Password>
  <PurchaseOrder>sample string 6</PurchaseOrder>
  <PurchasePrice>5.1</PurchasePrice>
  <Quantity>3</Quantity>
  <SectorId>15</SectorId>
  <StartDate>2025-05-07T01:27:48.2015538-07:00</StartDate>
  <State>sample string 10</State>
  <UserName>sample string 11</UserName>
</PlaceOrderwithPartnerCreatePost>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PlaceOrderWithPartnerCreateSuccess

Name	Type	Additional information
NewPartnerCreated	boolean	None.
MainContactUser	CreateUserSuccess	None.
NewUserCreated	CreateUserSuccess	None.
JasperactiveTeacherCode	string	None.
OrderId	string	None.
Successful	boolean	None.
MsgSuccess	string	None.

Response Formats

application/json, text/json

Sample:

{
  "NewPartnerCreated": true,
  "MainContactUser": {
    "NewUser": true,
    "UserName": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Successful": true,
    "MsgSuccess": "sample string 6"
  },
  "NewUserCreated": {
    "NewUser": true,
    "UserName": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Successful": true,
    "MsgSuccess": "sample string 6"
  },
  "JasperactiveTeacherCode": "sample string 2",
  "OrderId": "sample string 3",
  "Successful": true,
  "MsgSuccess": "sample string 5"
}

application/xml, text/xml

Sample:

<PlaceOrderWithPartnerCreateSuccess xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServices.Repositories.Response">
  <MsgSuccess>sample string 5</MsgSuccess>
  <Successful>true</Successful>
  <OrderId>sample string 3</OrderId>
  <JasperactiveTeacherCode>sample string 2</JasperactiveTeacherCode>
  <MainContactUser>
    <MsgSuccess>sample string 6</MsgSuccess>
    <Successful>true</Successful>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <NewUser>true</NewUser>
    <UserName>sample string 2</UserName>
  </MainContactUser>
  <NewPartnerCreated>true</NewPartnerCreated>
  <NewUserCreated>
    <MsgSuccess>sample string 6</MsgSuccess>
    <Successful>true</Successful>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <NewUser>true</NewUser>
    <UserName>sample string 2</UserName>
  </NewUserCreated>
</PlaceOrderWithPartnerCreateSuccess>