Sign In
Sign Up

Sender / Get by Affiliate ID

Get sender data by affiliate id (Partner sender uniquekey)

Request Header Authorization
Authentication Yes

API Endpoint

{{ServerUrl}}api/v1/sender/getbyaffiliateid/{id}
GET

API Parameters

Request Parameter

Field DataType Required Description
id string Yes affiliate id

Response Parameter

Field DataType Description
status string response status
message string response message
payload
id integer sender id
senderName string sender name
affiliateSenderId integer affiliate sender id
partnerId integer partner id
partnerName string partner name
titleId integer title id
titleName string title name
firstName string first name
lastName string last name
address string address
suburb string suburb
state string state
postcode string postcode
countryId integer country id
countryName string country name
countryCode string country code
phoneCountryId integer phone country id
phoneCountryCode string phone country code
phoneNo string phone no
dateOfBirth date date of birth
email string email
occupation string occupation
placeOfBirthCountryId integer place of birth country id
placeOfBirthCountryName string place of birth country name
placeOfBirthCountryCode string place of birth country code
nationalityId integer nationality id
nationalityName string nationality name
nationalityCode string nationality code
senderTypeId integer sender type id
senderTypeName string sender type name
senderTypeCode string sender type code
primaryDocumentId integer primary document id
primaryDocumentTypeId integer primary document type id
primaryDocumentTypeName string primary document type name
primaryDocumentNo string primary document no
primaryDocumentExpiryDate Date primary document expiry date
primaryDocumentName string primary document name
createdOn datetime created on
createdByName string created by name
modifiedOn datetime modified on
modifiedByName string modified by name

 

Sample JSON Request:

				
					{
    "senderTypeId": null,
    "createdOnFrom": "2022-01-31T20:07:04.004724Z",
    "createdOnTo": "2024-05-31T20:07:04.104724Z",
    "filter": "",
    "page": 0,
    "size": 1,
    "orderBy": [
        {
            "column": "id",
            "orderType": "Desc"
        }
    ]
}

Response Codes and Statuses

Status Code Error Description
000 Success

Error Codes

Status Code Error Description
101 General/Process error (see message)
301 Permission denined
401 Unauthorized
500 Internal server error (see message)

Sample JSON Responses: Success

				
					{
    "status": "000",
    "message": "Success",
    "payload": {
        "id": 11,
        "senderName": "Prasit1_00011 Sriket",
        "affiliateSenderId": "PRASIT.SRIKET.1.00011",
        "partnerId": 1,
        "partnerName": "Partner 001",
        "titleId": 1,
        "titleName": "Mr.",
        "firstName": "Prasit1_00011",
        "firstNameHash": null,
        "lastName": "Sriket",
        "address": "17/20",
        "suburb": "Aus",
        "state": "Aus",
        "postcode": "10240",
        "countryId": 1,
        "countryName": "ANDORRA",
        "countryCode": "AND",
        "phoneCountryId": 1,
        "phoneCountryCode": "376",
        "phoneNo": "815981742",
        "dateOfBirth": "1978-12-24T17:00:00Z",
        "email": "josriket@gmail.com",
        "occupation": null,
        "placeOfBirthCountryId": 1,
        "placeOfBirthCountryName": "ANDORRA",
        "placeOfBirthCountryCode": "AND",
        "nationalityId": 1,
        "nationalityName": "Afghanistan",
        "nationalityCode": "AFG",
        "senderTypeId": 1,
        "senderTypeName": "Individual",
        "senderTypeCode": "I",
        "primaryDocumentId": 11,
        "primaryDocumentTypeId": 1,
        "primaryDocumentTypeName": "Passport",
        "primaryDocumentNo": "P00000011",
        "primaryDocumentExpiryDate": "2013-12-26T00:00:00",
        "primaryDocumentName": "test.png",
        "createdOn": "2023-12-25T17:52:24.15012Z",
        "createdBy": 1,
        "createdByName": "SystemAdmin",
        "modifiedOn": "2023-12-25T17:52:25.573653Z",
        "modifiedBy": 1,
        "modifiedByName": "System Admin"
    }
}

Change Log

–