POST api/v1/addressbook/contacts

This method adds a new contact to the system. The system checks that the mobile number and email address are valid and if the validation is requested, the system will send a message to the contact to check the details are correct.

Request Information

URI Parameters

None.

Body Parameters

Either xml or json request.

AddressBook
NameDescriptionTypeAdditional information
PersonNumber

The unique identifier for the contact.

integer

Required

FirstName

The first name of the contact.

string

Required

LastName

The last name of the contact.

string

Required

MobilePhone

The mobile / cell number of thet contact.

string

Required

EmailAddress

The email address of the contact.

string

Required

Password

The password of the contact.

string

None.

LoginType

The type of authentication the contact uses when reading an SMS+ message.

integer

None.

DateCreated

date

Required

DateModified

The date the contact was last modified.

date

None.

LastModifiedBy

The Name of the user who last modified this contact details.

string

None.

VetoValidation

Dertemines if the contact should not be validated if true.

boolean

Required

Request Formats

application/json, text/json

Sample:
{
  "PersonNumber": 1,
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "MobilePhone": "sample string 4",
  "EmailAddress": "sample string 5",
  "Password": "sample string 6",
  "LoginType": 7,
  "DateCreated": "2017-11-17T15:48:38.3353657Z",
  "DateModified": "2017-11-17T15:48:38.3353657Z",
  "LastModifiedBy": "sample string 8",
  "VetoValidation": true
}

application/xml, text/xml

Sample:
<AddressBook xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PersonNumber>1</PersonNumber>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <MobilePhone>sample string 4</MobilePhone>
  <EmailAddress>sample string 5</EmailAddress>
  <Password>sample string 6</Password>
  <LoginType>7</LoginType>
  <DateCreated>2017-11-17T15:48:38.3353657Z</DateCreated>
  <DateModified>2017-11-17T15:48:38.3353657Z</DateModified>
  <LastModifiedBy>sample string 8</LastModifiedBy>
  <VetoValidation>true</VetoValidation>
</AddressBook>

Response Information

Resource Description

Details of the contact that have been created.

ResponseOfAddressBook
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfAddressBook

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "PersonNumber": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "MobilePhone": "sample string 4",
      "EmailAddress": "sample string 5",
      "Password": "sample string 6",
      "LoginType": 7,
      "DateCreated": "2017-11-17T15:48:38.3509502Z",
      "DateModified": "2017-11-17T15:48:38.3509502Z",
      "LastModifiedBy": "sample string 8",
      "VetoValidation": true
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfAddressBook xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <PersonNumber>1</PersonNumber>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <MobilePhone>sample string 4</MobilePhone>
      <EmailAddress>sample string 5</EmailAddress>
      <Password>sample string 6</Password>
      <LoginType>7</LoginType>
      <DateCreated>2017-11-17T15:48:38.3509502Z</DateCreated>
      <DateModified>2017-11-17T15:48:38.3509502Z</DateModified>
      <LastModifiedBy>sample string 8</LastModifiedBy>
      <VetoValidation>true</VetoValidation>
    </Detail>
  </ResponseData>
</ResponseOfAddressBook>