POST v1/core/accounts/{accId}/devices/apndevices/{apnDevId}/mdm/apple

Enrol APN device for Mobile Device Management

Request Information

Parameters

Name	Description	Additional information
accId	Account ID	Define this parameter in the request URI.
apnDevId	APN Device ID	Define this parameter in the request URI.
enrol	Enrolment detail, ServerURL, AccessRights, PayloadParams and Expiry	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "ServerURL": "sample string 1",
  "AccessRights": 2,
  "PayloadParams": {
    "PayloadDescription": "sample string 1",
    "PayloadDisplayName": "sample string 2",
    "PayloadOrganization": "sample string 3",
    "PayloadRemovalDisallowed": "sample string 4"
  },
  "Expiry": "2025-05-05T10:16:50.1938755+00:00"
}

text/javascript

Sample:

{"ServerURL":"sample string 1","AccessRights":2,"PayloadParams":{"PayloadDescription":"sample string 1","PayloadDisplayName":"sample string 2","PayloadOrganization":"sample string 3","PayloadRemovalDisallowed":"sample string 4"},"Expiry":"2025-05-05T10:16:50.1938755+00:00"}

application/xml, text/xml

Sample:

<AppleMDMDeviceEnrolment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <AccessRights>2</AccessRights>
  <Expiry>2025-05-05T10:16:50.1938755+00:00</Expiry>
  <PayloadParams>
    <PayloadDescription>sample string 1</PayloadDescription>
    <PayloadDisplayName>sample string 2</PayloadDisplayName>
    <PayloadOrganization>sample string 3</PayloadOrganization>
    <PayloadRemovalDisallowed>sample string 4</PayloadRemovalDisallowed>
  </PayloadParams>
  <ServerURL>sample string 1</ServerURL>
</AppleMDMDeviceEnrolment>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AppleMDMDeviceEnrolment'.

application/bson

Sample:

ServerURLsample string 1AccessRightsPayloadParams�PayloadDescriptionsample string 1PayloadDisplayNamesample string 2PayloadOrganizationsample string 3PayloadRemovalDisallowedsample string 4	Expiry��

Response Information

Enrolment details

Response body formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "ServerURL": "sample string 1",
    "AccessRights": 2,
    "PayloadParams": {
      "PayloadDescription": "sample string 1",
      "PayloadDisplayName": "sample string 2",
      "PayloadOrganization": "sample string 3",
      "PayloadRemovalDisallowed": "sample string 4"
    },
    "Expiry": "2025-05-05T10:16:50.1938755+00:00"
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:

{"Success":true,"Data":{"ServerURL":"sample string 1","AccessRights":2,"PayloadParams":{"PayloadDescription":"sample string 1","PayloadDisplayName":"sample string 2","PayloadOrganization":"sample string 3","PayloadRemovalDisallowed":"sample string 4"},"Expiry":"2025-05-05T10:16:50.1938755+00:00"},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:

<PBNBReturnOfAppleMDMDeviceEnrolmentCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <AccessRights>2</AccessRights>
    <Expiry>2025-05-05T10:16:50.1938755+00:00</Expiry>
    <PayloadParams>
      <PayloadDescription>sample string 1</PayloadDescription>
      <PayloadDisplayName>sample string 2</PayloadDisplayName>
      <PayloadOrganization>sample string 3</PayloadOrganization>
      <PayloadRemovalDisallowed>sample string 4</PayloadRemovalDisallowed>
    </PayloadParams>
    <ServerURL>sample string 1</ServerURL>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfAppleMDMDeviceEnrolmentCA1DLPoZ>

application/bson

Sample:

eSuccessDataServerURLsample string 1AccessRightsPayloadParams�PayloadDescriptionsample string 1PayloadDisplayNamesample string 2PayloadOrganizationsample string 3PayloadRemovalDisallowedsample string 4	Expiry��ErrorCodeErrorDescriptionsample string 3Metasample string 4