GET api/v2/addressbook/stoplog?Page={Page}&NoOfRecords={NoOfRecords}

This method returns a list of all addressbook phone numbers that have a stop log request against them or are invalid numbers. Note it will only give results for the loged in user and inherited contacts will not be included. Filtering can be applied. Filters the database using firstname, lastname, emailaddress and mobile phone. Only the records matching every criteria will be returned. If a field is left empty, then no filter will be applied using that field Determines the index to start outputting the contacts from a list returned from the database. (Default : 0) and how many records are to be returned from the database (Default : 20)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AddressBookGroupID

Allows to restrict all contacts that belong to a certain group.

globally unique identifier

None.

EmailAddress

Email address of the person in addressbook

string

None.

FirstName

First name of the person in addressbook

string

None.

LastName

Last name of the person in addressbook

string

None.

MobilePhone

Comma delimited list of mobile numbers to search for in the addressbook

string

None.

PersonNumbers

List all the person numbers to display the contact details.

Collection of integer

None.

Page

The Page number for the report.

integer

Required

NoOfRecords

The number of records to return per page.

integer

Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfAddressBookValidationResponse
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfAddressBookValidationResponse

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": {
      "TotalNumbersChecked": 1,
      "TotalNumbersFound": 2,
      "Addressbookdetails": [
        {
          "PersonNo": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "EmailAddress": "sample string 4",
          "MobileNumber": "sample string 5",
          "Result": {
            "ShortCode": "sample string 3",
            "Reason": "sample string 4",
            "DateSubmitted": "sample str"
          }
        },
        {
          "PersonNo": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "EmailAddress": "sample string 4",
          "MobileNumber": "sample string 5",
          "Result": {
            "ShortCode": "sample string 3",
            "Reason": "sample string 4",
            "DateSubmitted": "sample str"
          }
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfAddressBookValidationResponse 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>
      <TotalNumbersChecked>1</TotalNumbersChecked>
      <TotalNumbersFound>2</TotalNumbersFound>
      <Addressbookdetails>
        <AddressBookStopLogSearch>
          <PersonNo>sample string 1</PersonNo>
          <FirstName>sample string 2</FirstName>
          <LastName>sample string 3</LastName>
          <EmailAddress>sample string 4</EmailAddress>
          <MobileNumber>sample string 5</MobileNumber>
          <Result>
            <ToBeRemoved>true</ToBeRemoved>
            <OptOut>sample string 2</OptOut>
            <ShortCode>sample string 3</ShortCode>
            <Reason>sample string 4</Reason>
            <DateSubmitted>sample str</DateSubmitted>
          </Result>
        </AddressBookStopLogSearch>
        <AddressBookStopLogSearch>
          <PersonNo>sample string 1</PersonNo>
          <FirstName>sample string 2</FirstName>
          <LastName>sample string 3</LastName>
          <EmailAddress>sample string 4</EmailAddress>
          <MobileNumber>sample string 5</MobileNumber>
          <Result>
            <ToBeRemoved>true</ToBeRemoved>
            <OptOut>sample string 2</OptOut>
            <ShortCode>sample string 3</ShortCode>
            <Reason>sample string 4</Reason>
            <DateSubmitted>sample str</DateSubmitted>
          </Result>
        </AddressBookStopLogSearch>
      </Addressbookdetails>
    </Detail>
  </ResponseData>
</ResponseOfAddressBookValidationResponse>