Partner Account Resource

Handle partner register request.

GET /prm_pm_rest/services/prm_pr/services/register/getMailServerConfig

Get Mail Server Configuration for partner.

Response Body
media type data type description
application/json object (JSON) GetMailServerConfigResponse when successful.
application/xml anyType (XML)

Example

Request
GET /prm_pr/services/register/getMailServerConfig
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /prm_pm_rest/services/prm_pr/services/account/PortalAccount/editUser

Edit user for partner.

Request Body
media type data type description
application/json EditUser (JSON) edit user information.
application/xml editUser (XML)
Response Body
media type data type description
application/json object (JSON) EditUserResponse when successful.
application/xml anyType (XML)

Example

Request
PUT /prm_pr/services/account/PortalAccount/editUser
Content-Type: application/json
Accept: application/json

                
{
  "editUser" : {
    "userInfo" : {
      "city" : "...",
      "company" : "...",
      "companyURL" : "...",
      "contacts" : [ {
        "address" : "...",
        "city" : "...",
        "contactTimeFrom" : "...",
        "contactTimeTo" : "...",
        "contactType" : "...",
        "country" : "...",
        "emailAddress" : "...",
        "firstName" : "...",
        "lastName" : "...",
        "phone" : [ {
        }, {
        } ],
        "preferredLanguage" : "...",
        "stateOrProvince" : "...",
        "title" : "...",
        "zipOrPostalCode" : "..."
      }, {
        "address" : "...",
        "city" : "...",
        "contactTimeFrom" : "...",
        "contactTimeTo" : "...",
        "contactType" : "...",
        "country" : "...",
        "emailAddress" : "...",
        "firstName" : "...",
        "lastName" : "...",
        "phone" : [ {
        }, {
        } ],
        "preferredLanguage" : "...",
        "stateOrProvince" : "...",
        "title" : "...",
        "zipOrPostalCode" : "..."
      } ],
      "country" : "...",
      "emailAddr" : "...",
      "financial" : {
        "bankAccountNumber" : "...",
        "bankAddress" : "...",
        "bankName" : "...",
        "bankRoutingNumber" : "...",
        "city" : "...",
        "country" : "...",
        "invoiceTo" : "...",
        "referenceAccount" : "...",
        "stateOrProvince" : "...",
        "taxID" : "...",
        "zipOrPostalCode" : "..."
      },
      "firstName" : "...",
      "lastName" : "...",
      "password" : "...",
      "phone" : "...",
      "securityAnswer" : "...",
      "securityAnswerChoice" : "...",
      "stateOrProvince" : "...",
      "status" : 12345,
      "streetAddress" : "...",
      "userName" : "...",
      "zipOrPostalCode" : "...",
      "slaGroup" : "...",
      "userType" : "...",
      "notificationId" : "..."
    }
  }
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

POST /prm_pm_rest/services/prm_pr/services/register/Register/getSPInfo

Get service provider (partner) information.

Request Body
media type data type description
application/json GetSPInfo (JSON) information to be provided for getting sp info.
application/xml getSPInfo (XML)
Response Body
media type data type description
application/json object (JSON) GetSPInfoResponse when successful.
application/xml anyType (XML)

Example

Request
POST /prm_pr/services/register/Register/getSPInfo
Content-Type: application/json
Accept: application/json

                
{
  "getSPInfo" : {
    "spInfo" : {
      "city" : "...",
      "company" : "...",
      "companyURL" : "...",
      "contacts" : [ {
        "address" : "...",
        "city" : "...",
        "contactTimeFrom" : "...",
        "contactTimeTo" : "...",
        "contactType" : "...",
        "country" : "...",
        "emailAddress" : "...",
        "firstName" : "...",
        "lastName" : "...",
        "phone" : [ {
        }, {
        } ],
        "preferredLanguage" : "...",
        "stateOrProvince" : "...",
        "title" : "...",
        "zipOrPostalCode" : "..."
      }, {
        "address" : "...",
        "city" : "...",
        "contactTimeFrom" : "...",
        "contactTimeTo" : "...",
        "contactType" : "...",
        "country" : "...",
        "emailAddress" : "...",
        "firstName" : "...",
        "lastName" : "...",
        "phone" : [ {
        }, {
        } ],
        "preferredLanguage" : "...",
        "stateOrProvince" : "...",
        "title" : "...",
        "zipOrPostalCode" : "..."
      } ],
      "country" : "...",
      "emailAddr" : "...",
      "financial" : {
        "bankAccountNumber" : "...",
        "bankAddress" : "...",
        "bankName" : "...",
        "bankRoutingNumber" : "...",
        "city" : "...",
        "country" : "...",
        "invoiceTo" : "...",
        "referenceAccount" : "...",
        "stateOrProvince" : "...",
        "taxID" : "...",
        "zipOrPostalCode" : "..."
      },
      "firstName" : "...",
      "lastName" : "...",
      "password" : "...",
      "phone" : "...",
      "securityAnswer" : "...",
      "securityAnswerChoice" : "...",
      "stateOrProvince" : "...",
      "status" : 12345,
      "streetAddress" : "...",
      "userName" : "...",
      "zipOrPostalCode" : "...",
      "slaGroup" : "...",
      "userType" : "...",
      "notificationId" : "..."
    }
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /prm_pm_rest/services/prm_pr/services/register/Register/getSPInfoSecurity

Get service provider (partner) information in security.

Request Body
media type data type description
application/json GetSPInfoSecurity (JSON) information to be provided for getting sp security info.
application/xml getSPInfoSecurity (XML)
Response Body
media type data type description
application/json object (JSON) GetSPInfoSecurityResponse when successful.
application/xml anyType (XML)

Example

Request
POST /prm_pr/services/register/Register/getSPInfoSecurity
Content-Type: application/json
Accept: application/json

                
{
  "getSPInfoSecurity" : {
    "spInfo" : {
      "city" : "...",
      "company" : "...",
      "companyURL" : "...",
      "contacts" : [ {
        "address" : "...",
        "city" : "...",
        "contactTimeFrom" : "...",
        "contactTimeTo" : "...",
        "contactType" : "...",
        "country" : "...",
        "emailAddress" : "...",
        "firstName" : "...",
        "lastName" : "...",
        "phone" : [ {
        }, {
        } ],
        "preferredLanguage" : "...",
        "stateOrProvince" : "...",
        "title" : "...",
        "zipOrPostalCode" : "..."
      }, {
        "address" : "...",
        "city" : "...",
        "contactTimeFrom" : "...",
        "contactTimeTo" : "...",
        "contactType" : "...",
        "country" : "...",
        "emailAddress" : "...",
        "firstName" : "...",
        "lastName" : "...",
        "phone" : [ {
        }, {
        } ],
        "preferredLanguage" : "...",
        "stateOrProvince" : "...",
        "title" : "...",
        "zipOrPostalCode" : "..."
      } ],
      "country" : "...",
      "emailAddr" : "...",
      "financial" : {
        "bankAccountNumber" : "...",
        "bankAddress" : "...",
        "bankName" : "...",
        "bankRoutingNumber" : "...",
        "city" : "...",
        "country" : "...",
        "invoiceTo" : "...",
        "referenceAccount" : "...",
        "stateOrProvince" : "...",
        "taxID" : "...",
        "zipOrPostalCode" : "..."
      },
      "firstName" : "...",
      "lastName" : "...",
      "password" : "...",
      "phone" : "...",
      "securityAnswer" : "...",
      "securityAnswerChoice" : "...",
      "stateOrProvince" : "...",
      "status" : 12345,
      "streetAddress" : "...",
      "userName" : "...",
      "zipOrPostalCode" : "...",
      "slaGroup" : "...",
      "userType" : "...",
      "notificationId" : "..."
    }
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /prm_pm_rest/services/prm_pr/services/register/Register/registerSP

Register service provider (partner).

Request Body
media type data type description
application/json RegisterSP (JSON) service provider to be registered.
application/xml registerSP (XML)
Response Body
media type data type description
application/json object (JSON) RegisterSPResponse when successful.
application/xml anyType (XML)

Example

Request
POST /prm_pr/services/register/Register/registerSP
Content-Type: application/json
Accept: application/json

                
{
  "registerSP" : {
    "spInfo" : {
      "city" : "...",
      "company" : "...",
      "companyURL" : "...",
      "contacts" : [ {
        "address" : "...",
        "city" : "...",
        "contactTimeFrom" : "...",
        "contactTimeTo" : "...",
        "contactType" : "...",
        "country" : "...",
        "emailAddress" : "...",
        "firstName" : "...",
        "lastName" : "...",
        "phone" : [ {
        }, {
        } ],
        "preferredLanguage" : "...",
        "stateOrProvince" : "...",
        "title" : "...",
        "zipOrPostalCode" : "..."
      }, {
        "address" : "...",
        "city" : "...",
        "contactTimeFrom" : "...",
        "contactTimeTo" : "...",
        "contactType" : "...",
        "country" : "...",
        "emailAddress" : "...",
        "firstName" : "...",
        "lastName" : "...",
        "phone" : [ {
        }, {
        } ],
        "preferredLanguage" : "...",
        "stateOrProvince" : "...",
        "title" : "...",
        "zipOrPostalCode" : "..."
      } ],
      "country" : "...",
      "emailAddr" : "...",
      "financial" : {
        "bankAccountNumber" : "...",
        "bankAddress" : "...",
        "bankName" : "...",
        "bankRoutingNumber" : "...",
        "city" : "...",
        "country" : "...",
        "invoiceTo" : "...",
        "referenceAccount" : "...",
        "stateOrProvince" : "...",
        "taxID" : "...",
        "zipOrPostalCode" : "..."
      },
      "firstName" : "...",
      "lastName" : "...",
      "password" : "...",
      "phone" : "...",
      "securityAnswer" : "...",
      "securityAnswerChoice" : "...",
      "stateOrProvince" : "...",
      "status" : 12345,
      "streetAddress" : "...",
      "userName" : "...",
      "zipOrPostalCode" : "...",
      "slaGroup" : "...",
      "userType" : "...",
      "notificationId" : "..."
    }
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

PUT /prm_pm_rest/services/prm_pr/services/register/partner/passphrase

Reset user password.

Request Body
media type data type description
application/json PassphraseResetInfo (JSON) information to reset password.
application/x-www-form-urlencoded (custom)
application/xml passphraseResetInfo (XML)
Response Body
media type data type description
application/json object (JSON) PassphraseResetResponse when successful.
application/xml anyType (XML)

Example

Request
PUT /prm_pr/services/register/partner/passphrase
Content-Type: application/json
Accept: application/json

                
{
  "passphraseResetInfo" : {
    "username" : "...",
    "securityInfo" : "...",
    "newPassphrase" : "..."
  }
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /prm_pm_rest/services/prm_pr/services/account/PortalAccount/getUserByName/{userName}

getUserByName for partner.

Request Parameters
name type description
userName path the userName in url.
Response Body
media type data type description
application/json object (JSON) GetUserByNameResponse when successful.
application/xml anyType (XML)

Example

Request
GET /prm_pr/services/account/PortalAccount/getUserByName/{userName}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /prm_pm_rest/services/prm_pr/services/register/partner/passphrase/ResetLink

Generate password reset link, send the link to the specified email.

Request Body
media type data type description
application/json PassphraseResetLinkInfo (JSON) information to generate password reset link.
application/xml passphraseResetLinkInfo (XML)
Response Body
media type data type description
application/json object (JSON) PassphraseResetLinkResponse when successful.
application/xml anyType (XML)

Example

Request
POST /prm_pr/services/register/partner/passphrase/ResetLink
Content-Type: application/json
Accept: application/json

                
{
  "passphraseResetLinkInfo" : {
    "email" : "...",
    "username" : "...",
    "urlBase" : "..."
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...